Retrieve list of ingredients

Retrieve a list of ingredients and the associated details.

The in_stock_qty value is most commonly used to for tracking ingredient inventory and determining if a dish is available to order in the client app. A 0 or other non-positive value tells the client app to make a dish unavailable to order if that ingredient is considered essential.

GET /ingredients

Retrieve list of ingredients

cURL

curl --request GET \
  --url https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/ingredients

200

{
  "results": [
    {
      "id": "674d0bf5c28b69001f8e03a1",
      "created_at": "2024-04-22T10:00:00Z",
      "updated_at": "2024-04-22T10:00:00Z",
      "name": "Carrot",
      "in_stock_qty": 3,
      "price": 999
    }
  ],
  "total_results": 1
}

Query Parameters

sort · string

Sort the list in the response by a specific property. Used with the order parameter.

order · string

Set the sort order to asc for ascending or desc for descending. Must be used with the sort parameter.

fields · string

Restrict which properties are returned in the response.

filter · string

Filter the response to include only items that have properties equal to the specified value.

Example:

"created_at.gt~2024-05-07|in_stock_qty.lt~5"

limit · integer

Limit the number of objects in the response.

Required range: x <= 30

offset · integer

Offsets the start of the list by the set value. Defaults to 0.

Example:

0

Response

200

application/json

Request successful

results · object[]

Show child attributes

total_results · integer

Example:

1