Skip to main content

Labels

Two endpoints return labels: a list of the labels on your account, and the full detail of one label.

List labels​

GET /labels

Returns the labels you can see in Nutritionist Pro, newest ID first. Labels in Draft status are left out.

Query parameters​

  • limit. Number of labels to return, from 1 to 200. The default is 50.
  • offset. Number of labels to skip. The default is 0.
  • updated_since and updated_until. Return only labels changed in a date range.

The labels list has one view. The view parameter is not used.

See Lists and syncing for how these parameters behave.

Example request​

curl -H "Authorization: Bearer <API_KEY>" \
  "https://dev.nutritionistpro.com/v3/customer/labels?limit=1"

Example response​

{
  "status": true,
  "code": 200,
  "data": [
    {
      "id": 1058,
      "name": "Banana bread, retail pack",
      "short_name": "Banana bread",
      "region": { "id": 2, "name": "Canada" },
      "label_type_id": 31,
      "language_id": 6,
      "created_at": "2026-05-20T14:10:00Z",
      "updated_at": "2026-05-21T08:15:42Z",
      "creator": { "id": 4210, "name": "Test User" },
      "account": { "id": 518, "name": "Test Account" }
    }
  ],
  "meta": { "total": 9, "limit": 1, "offset": 0 }
}

Label fields​

  • id. The label ID. Use it with Get one label.
  • name. The label name.
  • short_name. The label's short name, or null.
  • region. The label's region as id and name, or null if the label has no region.
  • label_type_id. The ID of the label format.
  • language_id. The ID of the label language.
  • created_at and updated_at. Dates and times in UTC.
  • creator. The user who created the label.
  • account. The account that user belongs to.

Get one label​

GET /labels/{id}

Returns one label with its footnote and the foods on it. A label that does not exist, is in Draft status, or belongs to another account returns 404 with the message Label not found.

Example request​

curl -H "Authorization: Bearer <API_KEY>" \
  "https://dev.nutritionistpro.com/v3/customer/labels/1058"

Example response​

The nutrients list is shortened here.

{
  "status": true,
  "code": 200,
  "data": {
    "id": 1058,
    "name": "Banana bread, retail pack",
    "short_name": "Banana bread",
    "region": { "id": 2, "name": "Canada" },
    "label_type_id": 31,
    "language_id": 6,
    "created_at": "2026-05-20T14:10:00Z",
    "updated_at": "2026-05-21T08:15:42Z",
    "creator": { "id": 4210, "name": "Test User" },
    "account": { "id": 518, "name": "Test Account" },
    "foot_note": null,
    "foods": [
      {
        "food_id": 2000147,
        "serving": {
          "household_measure": "1 slice",
          "metric_value": 85.0,
          "metric_unit": "gram(s)"
        },
        "ingredient_statement": "Bananas, flour blend (wheat), sugar, eggs, butter (milk).",
        "allergen_statement": "Contains: Wheat, Eggs, Milk.",
        "nutrients": [
          { "id": 1, "name": "Calories", "unit": "kilocalorie(s)", "value": 210.556, "rounded_value": 210.0 },
          { "id": 4, "name": "Fat", "unit": "gram(s)", "value": 6.84, "rounded_value": 7.0 }
        ]
      }
    ]
  }
}

Detail fields​

The detail carries every list field, plus:

  • foot_note. The label's footnote text, or null.
  • foods. The foods on the label. Most labels have one. Label formats that show several products, such as an aggregate label, have one entry for each.

Food fields​

  • food_id. The ID of the recipe or ingredient the label was made from.
  • serving. The serving printed on the label: household_measure, metric_value, and metric_unit.
  • ingredient_statement. The ingredient statement saved on the label, or null.
  • allergen_statement. The allergen statement saved on the label, or null.
  • nutrients. The nutrient values saved on the label.

Label nutrient fields​

  • id. The nutrient ID.
  • name and unit. The name and unit saved on the label.
  • value. The value before rounding.
  • rounded_value. The rounded value saved on the label, which follows the rounding rules of the label's region.

A label holds its own copy of the values​

A label stores the nutrient values it was saved with. They are returned as saved on the label, so they can differ from the current values of the recipe if the recipe was changed afterward. In Nutritionist Pro, a label in that state shows a notice that its values differ from the recipe, with a Refresh action.

Label nutrients are also not limited to the published nutrient list used for recipes and ingredients. See Nutrients.