GET
/
orders
Retrieve a list of orders
curl --request GET \
  --url https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/orders
{
  "results": [
    {
      "id": "674d0bf5c28b69001f8e03a1",
      "created_at": "2024-04-22T10:00:00Z",
      "updated_at": "2024-04-22T10:00:00Z",
      "name": "John",
      "table_number": 8,
      "dish_ids": [
        "692a4a34a46ecf001f35ac6f",
        "6a4a857c022eb7001f9b8972",
        "6b7c2441a0db43001f9bf377"
      ],
      "special_requests": "<string>",
      "priority": 3,
      "scheduled_at": null,
      "status": "Received"
    }
  ],
  "total_results": 20
}

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:

"table_number.lt~5|status.eq~On the Way"

​
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

The response is of type object.