List work detail labels

GET

/v1/work-detail-labels

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

• Production

Returns your agency’s work detail labels, ordered by workDetailId. Work detail labels rename the work-detail fields on a worker record. The five that can be relabelled are DNI, HiWiz, special rates, safety boots and digital tacho.

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.

Authorizations

• Bearer

Responses

200

OK

Media typeapplication/json

object

labels

Array<object>

object

workDetailId

integer format: int32

dniLabel

string

nullable

hiVizLabel

string

nullable

specialRatesLabel

string

nullable

safetyBootsLabel

string

nullable

digitalTachoLabel

string

nullable

Example^generated

{
  "labels": [
    {
      "workDetailId": 1,
      "dniLabel": "example",
      "hiVizLabel": "example",
      "specialRatesLabel": "example",
      "safetyBootsLabel": "example",
      "digitalTachoLabel": "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"
}