Home
API Reference
Start typing to search…

List Products

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

List all products for a workspace

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Query Params
string

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

string

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

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

ID

string | null

Product Public ID

integer
required

Workspace ID

string
required

Product name

string | null

Current Path

boolean | null

Archived

boolean | null

Visible in Store

boolean | null

Visible in Customer Center

string | null

Image

string | null

A clear title without branding or mentioning the domain itself. Longer is better, but max is 60 characters.

string | null

A clear SEO description, at least two sentences long. Longer is better, but max is 160 characters. You will find the actual user-facing description on the default variant of the product (see the Products::Variant resource).

string | null

SEO image

boolean | null

Commissionable

array | null

Images

image_ids
integer
required

The ID of the default variant of the product

array | null

Variant IDs

variant_ids
array | null

Price IDs

price_ids
array | null

Any valid array, empty or with valid tags will overwrite existing values. To avoid losing existing tags first use the Fetch Product endpoint, then be sure to include the existing tags in your payload along with any new addition(s)

tag_ids
string | null

Redirect funnel

string | null

Cancellation Funnel Url

date-time | null

Added

date-time | null

Updated

array of objects | null

Properties that are specific to the default variant of a product

variant_properties
object
integer
required

ID

string
required

Name

Headers
object
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.

string

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

Updated 7 months ago

Language
Credentials
URL

Updated 7 months ago