Get availability status details

GET

/v1/availability-statuses/{id}

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

• Production

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

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.

Authorizations

• Bearer

Parameters

Path Parameters

id

required

integer format: int32

The id path parameter

Responses

200

OK

Media typeapplication/json

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

Example^generated

{
  "availabilityStatusId": 1,
  "availabilityStatusName": "example",
  "awrSpecific": true,
  "displayInWorkerApp": true,
  "displayTextInWorkerApp": "example"
}

401

Unauthorized

Media typeapplication/problem+json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

403

Forbidden

Media typeapplication/problem+json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

Media typeapplication/problem+json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}