Skip to main content
GET
/
clients
/
{id}
/
workers
Get Client Workers
curl --request GET \
  --url https://api.roostedhr.com/api/1_12/clients/{id}/workers \
  --header 'X-API-KEY: <api-key>'
{
  "preferred": [
    {
      "personnel_id": "<string>",
      "name": "<string>",
      "date": "<string>"
    }
  ],
  "normal": [
    {
      "personnel_id": "<string>",
      "name": "<string>",
      "date": "<string>"
    }
  ],
  "banned": [
    {
      "personnel_id": "<string>",
      "name": "<string>",
      "date": "<string>"
    }
  ]
}
The response groups all company workers into three arrays by their preference status for this client: preferred, normal, and banned.

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string
required

Client ID

Response

OK

Workers grouped by their preference status for this client.

​
preferred
ClientWorkerEntry · object[]

Workers with preferred status.

​
normal
ClientWorkerEntry · object[]

Workers with normal (default) status.

​
banned
ClientWorkerEntry · object[]

Workers excluded from this client's events.