Skip to main content
GET
/
clients
/
{id}
/
orders
Get Client Orders
curl --request GET \
  --url https://api.roostedhr.com/api/1_12/clients/{id}/orders \
  --header 'X-API-KEY: <api-key>'
{
  "orders": [
    {
      "id": "<string>",
      "name": "<string>",
      "comments": "<string>",
      "order_comments": "<string>",
      "time_start": "<string>",
      "time_end": "<string>",
      "location": "<string>",
      "address": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "order_created": "<string>",
      "shifts": [
        {
          "id": "<string>",
          "custom_name": "<string>",
          "role_id": "<string>",
          "quantity": 123,
          "start": "<string>",
          "end": "<string>",
          "overnight": true,
          "comments": "<string>"
        }
      ]
    }
  ],
  "total": 12
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string
required

Client ID

Query Parameters

​
page
integer
default:1

Page number to retrieve.

Example:

1

​
items_per_page
integer
default:25

Number of orders per page.

Example:

25

Response

OK

​
orders
ClientOrder · object[]

List of orders for the current page.

​
total
integer

Total number of orders across all pages.

Example:

12