List Collections

get https://{subdomain}.myclickfunnels.com/api/v2/workspaces/{workspace_id}/products/collections

List Collections

time	status	user agent
Retrieving recent requests…

Loading…

Path Params

workspace_id

integer

required

Query Params

after

string

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order

string

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property

string

Sort property of a list response. The default is id and thus the created_at order.
If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

filter

object

Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.

Responses

Response body

array of objects

object

integer

required

Numeric ID of the collection

public_id

string | null

Public ID is a string version of the numeric ID

workspace_id

integer

required

ID reference to the workspace to which the collection belongs

name

string

required

Name of the products collection

description

string | null

Description of the collection

collection_type

string | null

Type of the collection (manual or automatic)

product_ids

array | null

Array of product IDs in the collection. Updating with invalid or non-workspace product IDs will result in an error. If IDs from existing products in the collection are left out, they will be removed from the collection. You can also remove all the products from a collection by providing an empty array.

product_ids

sort_method

string | null

Method used to sort the products in the collection

manually name_asc name_desc price_desc price_asc added_at_desc added_at_asc created_at_desc created_at_asc

archived

boolean | null

Whether the collection is archived

image_id

string | null

Collection image

visible_in_store

boolean | null

Whether the collection is visible in the online store

current_path

string | null

Current path of the collection

seo_title

string | null

Title of the collection for SEO purposes

seo_description

string | null

Description of the collection for SEO purposes

seo_indexable

string | null

Whether the collection is indexable by search engines

social_image_id

string | null

Image for social sharing

created_at

string | null

Date and time the collection was created

updated_at

string | null

Date and time the collection was last updated

Headers

object

Pagination-Next

string

ID of the last item in the current response after which more records exist. You can use it in an after query parameter for cursor-based pagination to get to the next page.

Link

string

A direct link to the next page for the cursor-based pagination. It includes the after and the Pagination-Next ID value.

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://myworkspace.myclickfunnels.com/api/v2/workspaces/workspace_id/products/collections \
3
     --header 'accept: application/json'


xxxxxxxxxx
42
]
1
[
2
  {
3
    "id": 2,
4
    "public_id": "rUeIvy",
5
    "workspace_id": 42000,
6
    "name": "Example Collection",
7
    "description": "Example Description",
8
    "collection_type": "manual",
9
    "product_ids": [],
10
    "sort_method": "manually",
11
    "archived": false,
12
    "image_id": null,
13
    "visible_in_store": true,
14
    "current_path": null,
15
    "seo_title": "Example SEO Title",
16
    "seo_description": "Example SEO Description",
17
    "seo_indexable": null,
18
    "social_image_id": null,
19
    "created_at": null,
20
    "updated_at": null
21
  },
22
  {
23
    "id": 3,
24
    "public_id": "qcPusw",
25
    "workspace_id": 42000,

200OK

401Unauthorized

404Not Found