Get Client Workers - Roosted HR API Documentation

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

string

required

Client ID

Response

Workers grouped by their preference status for this client.

preferred

ClientWorkerEntry · object[]

Workers with preferred status.

Show child attributes

normal

ClientWorkerEntry · object[]

Workers with normal (default) status.

Show child attributes

banned

ClientWorkerEntry · object[]

Workers excluded from this client's events.

Show child attributes

Get Client Worker StatusReturns the preference status of a specific worker for this client.

{ "preferred": [ { "personnel_id": "<string>", "name": "<string>", "date": "<string>" } ], "normal": [ { "personnel_id": "<string>", "name": "<string>", "date": "<string>" } ], "banned": [ { "personnel_id": "<string>", "name": "<string>", "date": "<string>" } ] }