Skip to main content
GET
List Product Components

Authorizations

Authorization
string
header
required

Use a Bearer token to access this API.

Query Parameters

limit
integer<int64> | null

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

Required range: 1 <= x <= 100
offset
integer<int64> | null

Number of objects to skip before returning results.

Required range: x >= 0
starting_after
string | null

A cursor for use in pagination. starting_after is a component_nutrition_id that defines your place in the list — pass the one from the last object of the previous page to fetch the next.

Example:

"fcn_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

ending_before
string | null

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

Example:

"fcn_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

client_reference_id
string | null

Only return the component carrying this client_reference_id. The value is unique within your account and mode, so this returns at most one component — it is the direct answer to "have I registered this ingredient already?".

Example:

"example_value"

category
enum<string> | null

Only return components in this menu category.

Available options:
base,
protein,
topping,
premium,
dressing
Example:

"base"

canonical_food_key
string | null

Only return components carrying this price-book join key.

name
string | null

Only return components with this name, matched case-insensitively. Names are shared across accounts, so this is the dedupe lookup for a component you have no id for.

metadata
object

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

Example:

Response

An envelope wrapping a list of product component objects.

An envelope wrapping a list of product component objects.

product_components
object[]
required

The list of product components.