Skip to content
Skip to Content
Docs
Studio

Get Recipe Label Configuration

Get fully resolved label configuration, optionally pinned to a historical version.

Accepts ?version_id= to read configuration at a specific version snapshot.

Returns 404 when version_id is supplied but no matching version exists. Returns 500 when the stored version uses a data format that this API version cannot read.

Available only on API versions declaring the recipe_versioning capability. Requests without this capability receive a 404.

GET
/studio/recipes/{recipe_id}/label-configuration

Path Parameters

recipe_id*Recipe Id

Query Parameters

version_id?|

Leave out for the current recipe. To read an earlier version, pass a version_id from the recipe's version list.

Response Body

Successful Response

application/json
  1. response

Standard response envelope.

data*

Response data envelope.

meta*

Response metadata.

version_id?|

Version committed for this mutation; pass on the next request as If-Match for optimistic concurrency. Present only on versions declaring the recipe_versioning capability.

Example Request
curl -X GET 'https://api.bettermenu.live/studio/recipes/string/label-configuration'
Example Response
{  "data": {    "recipe_id": "string",    "nutrients": [      {        "bmid": "string",        "official_name": "string",        "visible": true,        "display_name": "string",        "display_name_override": "string",        "allowed_synonyms": [          "string"        ],        "is_mandatory": true,        "is_toggleable": true,        "source": "regulatory_default"      }    ],    "has_custom_configuration": true,    "created_by": "string",    "updated_at": "string",    "acknowledged_fills": [      {        "serving_id": "string",        "bmid": "string",        "basis": "string",        "fills_hash": "string",        "acknowledged_by": "string",        "acknowledged_at": "2019-08-24T14:15:22Z",        "channel": "string"      }    ]  },  "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.