v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB

Products

Get Product

Retrieves a product by ID. Resolves your own products, and (if you belong to an organization) products owned by a sibling account.

get/v1/products/{id}

Path parameters

idstring required

Example:fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Response

An envelope wrapping a single product object.

Example response

{
  "product": {
    "product_id": "fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "owner_partner_id": "facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "name": "Example",
    "description": "Premium SPF 50 mineral sunscreen",
    "created_at": "2026-06-15T14:30:00Z",
    "visit_type": "cbtSleep",
    "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"
  }
}