Skip to content

List availability statuses

GET
/v1/availability-statuses
curl --request GET \
--url https://api2.recruso.co.uk/v1/availability-statuses \
--header 'Authorization: <Authorization>'

Returns your agency’s availability statuses, ordered by availabilityStatusName. An availability status marks what a worker is doing on a given day — available, on holiday, at the doctor, on paternity leave.

The response is not paged.

You only ever see and change your own agency’s records; there is no owner id on the request, and an id belonging to another agency returns 404 rather than 403 so that its existence is never disclosed.

Access. Requires a client-credentials access token. Tokens issued through the interactive user login are rejected.

OK

Media typeapplication/json
object
availabilityStatuses
Array<object>
object
availabilityStatusId
integer format: int16
availabilityStatusName
string
awrSpecific

Whether AWR-specific breaks are applied to this status when a worker’s parity is calculated. The flag on its own is not enough: the status name must also be one of SICKNESS, JURY_SERVICE, MATERNITY, PATERNITY, ADOPTION or UNPAID_LEAVE, in upper case.

boolean
displayInWorkerApp

Whether this status is offered to workers in the Recruso Worker App, where a worker sets their own availability.

boolean
displayTextInWorkerApp
string
nullable
Examplegenerated
{
"availabilityStatuses": [
{
"availabilityStatusId": 1,
"availabilityStatusName": "example",
"awrSpecific": true,
"displayInWorkerApp": true,
"displayTextInWorkerApp": "example"
}
]
}

Unauthorized

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Forbidden

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}