List Product Components
Returns the product components you have registered, newest first.
Only components you have recorded nutrition for are listed: the underlying name table is shared across accounts, so listing it would return tens of thousands of rows that belong to nobody.
Results are paginated — the default limit is 10, so reading back a full menu
takes several requests. Pass the last object’s component_nutrition_id as
starting_after to fetch the next page, and keep going until a page comes back
shorter than your limit.
Rather than paging the whole catalogue to find one ingredient, filter it:
client_reference_id returns the single component carrying your own identifier,
name matches the shared component name case-insensitively, and category and
canonical_food_key narrow by those fields. Metadata is filtered with
metadata[key]=value, with multiple keys AND-ed. Filters combine with each other
and with the pagination cursors.
Authorizations
Use a Bearer token to access this API.
Query Parameters
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
1 <= x <= 100Number of objects to skip before returning results.
x >= 0A 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.
"fcn_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
A cursor for use in pagination. ending_before is a component_nutrition_id that defines your place in the list.
"fcn_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
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_value"
Only return components in this menu category.
base, protein, topping, premium, dressing "base"
Only return components carrying this price-book join key.
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.
Filter by metadata key-value pairs using bracket syntax. For example: metadata[lookup_key]=premium-plan. Multiple keys use AND logic.
Response
An envelope wrapping a list of product component objects.
An envelope wrapping a list of product component objects.
The list of product components.