Nutrients

The nutrient dictionary that food nutrient values refer to. Not paginated.

catalog:readhttps://public-api.nutrasoft.ca/v1

Linked fromFoodsnutrients[].nutrient_id

The Nutrient object

idinteger
is_major_nutrientboolean
Whether this nutrient appears on a standard nutrition facts panel.
labelstringnullable
Display label, where one differs from the name.
namestringnullable
uomstringnullable
The unit this nutrient's values are expressed in.

Operations

List nutrients

get/nutrientscatalog:read

The nutrient dictionary, shared by every account. Not paginated: every row is returned, ordered by name.

Query parameters

searchstringnullable
Free-text match on name or label, or the exact unit.

Returns

200 A page of Nutrient objects in data, with pagination.

Errors

400 401 403 429 500 503

GET /nutrients

curl "https://public-api.nutrasoft.ca/v1/nutrients" \
  -H "Authorization: Bearer $NUTRASOFT_API_KEY"

Response200

{
  "data": [
    {
      "id": 123,
      "is_major_nutrient": false,
      "label": "string",
      "name": "Sample name",
      "uom": "string"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 1,
    "has_more": false
  },
  "order": "id:asc"
}

Retrieve a nutrient

get/nutrients/{nutrient_id}catalog:read

Path parameters

nutrient_idintegerrequired
The nutrient's id.
- > 0

Returns

200 One Nutrient object in data.

Errors

400 401 403 404 429 500 503

GET /nutrients/{nutrient_id}

curl "https://public-api.nutrasoft.ca/v1/nutrients/123" \
  -H "Authorization: Bearer $NUTRASOFT_API_KEY"

Response200

{
  "data": {
    "id": 123,
    "is_major_nutrient": false,
    "label": "string",
    "name": "Sample name",
    "uom": "string"
  }
}