List Products

Returns a collection of products

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

company_id

string

An ID of a company to filter by, which will look like biz_*************

experience_id

string

An ID of an experience to filter by, which will look like exp_*************

page

integer

default:

1

The page number to retrieve

per

integer

default:

10

The number of resources to return per page. There is a limit of 50 results per page.

Response

200 - application/json

data

object[]

required

Show child attributes

data.company_id

string

required

The ID of the company, which will look like biz_*************

data.created_at

number

required

The date the product was created

data.id

string

required

The ID of the product, which will look like prod_*************

data.name

string

required

The name of the product

data.page_id

string

required

The ID of the page, which will look like page_*************

data.visibility

enum<string>

required

The visibility of the product

Available options:

visible,

hidden,

archived,

quick_link

data.description

string

The description of the product

pagination

object

required

Show child attributes

pagination.current_page

number

required

Current page number

pagination.next_page

number

required

Next page number

pagination.prev_page

number

required

Previous page number

pagination.total_count

number

required

Total number of records

pagination.total_pages

number

required

Total number of pages