Skip to content
Skip to Content
Docs
Studio

Get Ingredient

Resolve one ingredient by id — a custom ingredient (cing_… — the caller organization's own) or a standard reference ingredient, whichever the id belongs to.

GET
/studio/ingredients/{ingredient_id}

Path Parameters

ingredient_id*Ingredient Id

Ingredient id — cing_… or a standard reference id.

Query Parameters

market*"US"

The market to resolve this ingredient for.

Value in"US"

Response Body

Successful Response

application/json
  1. response

One resolved ingredient — custom or standard, by id.

status/used_in_recipes/density_g_per_ml/reference_amount/ reference_unit/reference_quantity_g are populated for kind: "custom" results only; source/category/brand_name/ brand_owner are populated for kind: "standard" results only. nutrients/portions are populated for either kind — empty only for a custom ingredient with no reference gram basis entered yet, or an id the rich resolver has nothing for.

id*Id

Ingredient id.

name*Name

Ingredient name.

kind*Kind

custom or standard.

market*Market

The market this ingredient was resolved for.

status?|

Lifecycle status (draft/active/archived). Populated for kind: "custom" results only.

used_in_recipes?|

Exact number of the caller's recipes that pin this ingredient. Populated for kind: "custom" results only.

source?|

"ingredient" (raw) or "product" (branded). Populated for kind: "standard" results only.

category?|

Reference-data food category. Populated for kind: "standard" results only.

brand_name?|

Branded-product brand name. Populated for kind: "standard" products only.

brand_owner?|

Branded-product owner. Populated for kind: "standard" products only.

nutrients?array<>

Nutrient values for this ingredient.

portions?array<>

Serving-size portions for this ingredient.

density_g_per_ml?|

Density, for volume conversion. Populated for kind: "custom" results only.

reference_amount?|

Reference serving amount, e.g. 15 for '15g'. Populated for kind: "custom" results only.

reference_unit?|

Reference serving unit. Populated for kind: "custom" results only.

reference_quantity_g?|

As-sold gram basis for the reference serving. Populated for kind: "custom" results only.

Example Request
curl -X GET 'https://api.bettermenu.live/studio/ingredients/string?market=US'
Example Response
{  "id": "string",  "name": "string",  "kind": "string",  "market": "string",  "status": "string",  "used_in_recipes": 0,  "source": "string",  "category": "string",  "brand_name": "string",  "brand_owner": "string",  "nutrients": [    {      "bmid": "string",      "name": "string",      "amount": "string",      "unit": "string",      "basis": "string"    }  ],  "portions": [    {      "id": "string",      "origin": "string",      "amount": "string",      "unit_name": "string",      "gram_weight": "string",      "modifier": "string"    }  ],  "density_g_per_ml": "string",  "reference_amount": "string",  "reference_unit": "string",  "reference_quantity_g": "string"}

Recipe in, FDA-format Nutrition Facts out, with every version kept.

Start freeNo card needed.