Sign in

v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB
Products

List Products

Returns a list of your products, sorted by creation date with the most recently created products appearing first. By default only active products are returned; pass active=false to list archived ones. You can also filter by client_reference_id or by metadata using metadata[key]=value query parameters.

get/v1/products

Query parameters

limitinteger nullable

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Example:10

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

offsetinteger nullable

Number of objects to skip before returning results.

Example:3

Number of objects to skip before returning results.

starting_afterstring nullable

A cursor for use in pagination. starting_after is a product ID that defines your place in the list.

Example:fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA

A cursor for use in pagination. starting_after is a product ID that defines your place in the list.

ending_beforestring nullable

A cursor for use in pagination. ending_before is a product ID that defines your place in the list.

Example:fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA

A cursor for use in pagination. ending_before is a product ID that defines your place in the list.

activeboolean nullable

Only return products where active matches this value.

Only return products where active matches this value.

client_reference_idstring nullable

Filter products by their client-provided product identifier.

Example:example_value

Filter products by their client-provided product identifier.

metadataobject

Filter by metadata key-value pairs using bracket syntax. For example: metadata[lookup_key]=premium-plan. Multiple keys use AND logic.

{
  "lookup_key": "premium-plan"
}

Response

An envelope wrapping a list of product objects.

Example response

{
  "products": [
    {
      "product_id": "fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "owner_partner_id": "facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "name": "Example",
      "description": "Premium SPF 50 mineral sunscreen",
      "created_at": "2026-06-15T14:30:00Z",
      "active": false,
      "hsa_fsa_eligibility": "not_eligible",
      "test_mode": false,
      "metadata": {
        "order_id": "8842",
        "channel": "shopify"
      },
      "url": "https://example.com",
      "client_reference_id": "obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
    }
  ]
}