Skip to content
Skip to Content
Docs
Studio

Get Custom Ingredient

Fetch a custom ingredient by id.

GET
/studio/custom-ingredients/{custom_ingredient_id}

Path Parameters

custom_ingredient_id*Custom Ingredient Id

Response Body

Successful Response

application/json
  1. response

Response for the get-custom-ingredient endpoint.

Also reused verbatim by getCustomIngredientVersion (an as-of read at a historical version_id) and restoreCustomIngredient (whose version_id is the newly committed restore commit) — the wire shape is identical in every case: the full entity plus the version_id it reflects.

data*

A custom ingredient's full data: identity, lifecycle status, serving/nutrition data, and descriptive attributes.

meta*

Response metadata.

version_id?|

Version this read reflects.

Example Request
curl -X GET 'https://api.bettermenu.live/studio/custom-ingredients/string'
Example Response
{  "data": {    "id": "stringstringstringstringst",    "org_id": "stringstringstringstrings",    "status": "draft",    "name": "string",    "entry_method": "form",    "notes": "string",    "reference_amount": "string",    "reference_unit": "string",    "household_measure": "string",    "reference_quantity_g": "string",    "density_g_per_ml": "string",    "nutrients": [      {        "id": "stringstringstringstringst",        "unit": "string",        "amount": "string",        "market_nutrients": {          "property1": {            "bmid": "string",            "nutrient_id": 1          },          "property2": {            "bmid": "string",            "nutrient_id": 1          }        }      }    ],    "approved_markets": [      "US"    ],    "brand": "string",    "manufacturer": "string",    "source_url": "string",    "attributes": [      {        "key": "string",        "type": "string",        "value": null,        "searchable": false      }    ],    "artifacts": [      {        "key": "string",        "kind": "string",        "uploaded_at": "2019-08-24T14:15:22Z"      }    ],    "ingredient_statement": "string",    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  },  "meta": {    "version": "string",    "request_id": "string",    "timestamp": "string"  },  "version_id": "string"}

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

Start freeNo card needed.