Sign in

v6

latestOpenAPI 3.1.02026-07-311856741.1 MB
products
public

List Products

List products.

Scopes: products:read products:write

get/v1/products/

Query parameters

string uuid4

The product ID.

OR
string[]

Filter by product ID.

string uuid4

The organization ID.

OR
string[]
Example:1dbfc517-0bbf-4301-9ba8-555ca42b9737

Filter by organization ID.

querystring nullable

Filter by product name.

Filter by product name.

is_archivedboolean nullable

Filter on archived products.

Filter on archived products.

is_recurringboolean nullable

Filter on recurring products. If true, only subscriptions tiers are returned. If false, only one-time purchase products are returned.

Filter on recurring products. If true, only subscriptions tiers are returned. If false, only one-time purchase products are returned.

string uuid4

The benefit ID.

OR
string[]

Filter products granting specific benefit.

visibilityProductVisibility[] nullable

Filter by visibility.

Filter by visibility.

pageinteger

Page number, defaults to 1.

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

Size of a page, defaults to 10. Maximum is 100.

sortingProductSortProperty[] nullable

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

metadataobject nullable

Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.

Response

Successful Response