Products

List product option groups

List the SELLABLE option groups of a product (finish, flavour, service level) with their values and price_adjustment.

  • The active filter applies to groups only; values always come back in full, each with is_active.
  • Cursor-paginated (limit, starting_after); a product of another company returns 404 product_not_found.
get/companies/{company}/products/{product}/options

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/products/{product}/options
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

productstring uuid required

Public identifier (UUID v7) of the product.

Query parameters

limitinteger

Number of objects to return, between 1 and 100 (default 25).

starting_afterstring uuid nullable

Cursor for forward pagination: pass the id of the last object on the previous page (the next_cursor of the previous response).

activeboolean

true returns only active items; false or omitted returns all of them.

Headers

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

has_moreboolean required

Whether more pages are available after this one.

next_cursorstring nullable required

Opaque cursor for the next page, or null when has_more is false. The example below shows the shape used by most listings; others return a different one, so pass the value back verbatim instead of validating it.

Example response

{
  "data": [
    {
      "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8c30",
      "object": "product_option_group",
      "product_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a09",
      "name": "Calidad",
      "required": true,
      "active": true,
      "values": [
        {
          "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8c31",
          "object": "product_option_value",
          "name": "Superior",
          "position": 1,
          "price_adjustment": "2.0000",
          "active": true
        }
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0c"
}

Changes

No recorded changes to this operation across all 1 revision of this API.