Skip to content
Docs
APISign inStart free

List products

The products.list operation: GET /api/v1/products in the REST API and the products_list tool in the MCP server.

GET/api/v1/products

Lists the brand's products in the request's mode, newest first. Filter with active (true or false) and kind (plan or standard).

Paginate with limit (1–100, default 10) and starting_after (the next_cursor of the previous page).

At a glance

  • REST: GET /api/v1/products
  • MCP tool: products_list
  • Operation ID: products.list
  • Scope: Brand
  • Permission: catalog:read
  • Risk tier: read
  • Dry run: Not supported
  • Idempotency: Not needed (read only)
  • Modes: Test and live
  • Pagination: limit (at most 100) and starting_after
  • Authentication: API key with the catalog:read scope
  • Since: M4

Request

Query parameters

FieldTypeRequiredDescription
activestringNoOnly active (true) or archived (false) products.
kindone of standard, planNo
limitinteger (1 to 100)No
starting_afterprod_… IDNo

Response

200 OK with a JSON object, a page of the list (newest first):

FieldTypeDescription
object"list"
dataarray of object
data[].idprod_… ID
data[].object"product"
data[].brandIdbrd_… ID
data[].livemodeboolean
data[].namestring
data[].descriptionstring or null
data[].taxCategoryIdone of 9 values, e.g. electronically_supplied_service, saas, ebook (all in the OpenAPI document)
data[].kindone of standard, plan
data[].entitlementsarray of object
data[].entitlements[].featureKeystring
data[].entitlements[].valueboolean or number or string
data[].lifetimeEntitlementsbooleanA one-time purchase of the product grants its entitlements for good (spec §36.1).
data[].displayOrderinteger or null
data[].highlightedboolean
data[].activeboolean
data[].imagesarray of string
data[].metadataobject
data[].createdAtdate-time
data[].updatedAtdate-time
has_moreboolean
next_cursorprod_… ID or null

Examples

Active plans

HTTP
GET /api/v1/products?active=true&kind=plan
Authorization: Bearer or_test_…

Response (200):

JSON
{
  "object": "list",
  "data": [
    {
      "id": "prod_01m4tx5nj8emwbyf7y9vcf47y0",
      "object": "product",
      "brandId": "brd_01m4tx5nj8emwbyf7y9vcf47x4",
      "livemode": false,
      "name": "Pro",
      "description": "For growing teams.",
      "taxCategoryId": "saas",
      "kind": "plan",
      "entitlements": [
        {
          "featureKey": "seats.max",
          "value": 10
        },
        {
          "featureKey": "feature.export",
          "value": true
        }
      ],
      "lifetimeEntitlements": false,
      "displayOrder": 2,
      "highlighted": true,
      "active": true,
      "images": [],
      "metadata": {},
      "createdAt": "2026-10-13T12:00:00.000Z",
      "updatedAt": "2026-10-13T12:00:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Errors

CodeHTTP statusWhenWhat to do
validation_failed400A filter or pagination value is malformed.Fix the fields listed in details.issues and send the request again.
permission_denied403You can't see this brand's catalog.Ask an organization owner or admin for a role or scope that allows this action.

It can also return these common errors: api_version_unsupported, authentication_required, api_key_invalid, scope_required, resource_not_found, dry_run_not_supported, rate_limited, internal_error.