POpolar
products
public

List Products

List products.

Scopes: products:read products:write

get/v1/products/

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/products/
  • Auth
    • OpenID Connect (/.well-known/openid-configuration, scopes: products:read, products:write)
    • or HTTP bearer
    • or HTTP bearer

Query parameters

string uuid4

The product ID.

OR
string[]
string uuid4

The organization ID.

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

Filter by product name.

is_archivedboolean nullable

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.

string uuid4

The benefit ID.

OR
string[]
visibilityProductVisibility[] nullable

Filter by visibility.

pageinteger

Page number, defaults to 1.

limitinteger

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.

metadataMetadataQuery nullable

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

Response

Successful Response

Changes

No recorded changes to this operation across all 11 revisions of this API.