Skip to main content
GET
List products
This page documents the Legacy API. For new integrations, use List Products in the Current API.
Required permissions:
  • access_pass:basic:read

Yetkilendirmeler

Authorization
string
header
gerekli

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

access_pass:basic:read

Sorgu Parametreleri

after
string

Returns the elements in the list that come after the specified cursor.

before
string

Returns the elements in the list that come before the specified cursor.

first
integer

Returns the first n elements from the list.

Örnek:

42

last
integer

Returns the last n elements from the list.

Örnek:

42

product_types
enum<string>[]

Filter to only products matching these type classifications.

The different types an product can be. Only use 'regular'. The rest are for internal use

Mevcut seçenekler:
regular,
app,
experience_upsell,
api_only
visibilities
enum<string>[]

Filter to only products matching these visibility states.

The different levels of visibility for resources

Mevcut seçenekler:
visible,
hidden,
archived,
quick_link,
all,
not_quick_link,
not_archived
order
enum<string>

The field to sort results by. Defaults to created_at.

Mevcut seçenekler:
active_memberships_count,
created_at,
usd_gmv,
usd_gmv_30_days
direction
enum<string>

The sort direction for results. Defaults to descending.

Mevcut seçenekler:
asc,
desc
created_before
string<date-time>

Only return products created before this timestamp.

Örnek:

"2023-12-01T05:00:00.401Z"

created_after
string<date-time>

Only return products created after this timestamp.

Örnek:

"2023-12-01T05:00:00.401Z"

account_id
string
gerekli

The unique identifier of the company to list products for.

Örnek:

"biz_xxxxxxxxxxxxxx"

Yanıt

A successful response

The connection type for PublicAccessPass.

data
object[]
gerekli

A list of nodes.

page_info
object
gerekli

Information to aid in pagination.