Skip to content
Recruso API

List worker types

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

Returns every worker type the platform publishes. The basis an agency engages a worker on. The values are Temporary, Permanent, Commercial Permanent, Limited, PSC-In Scope, PSC-Out of Scope and Swedish Derogation.

These values are platform-wide: every agency sees the same list and the same ids, and your agency cannot add to them or change them. Use the id wherever a request asks for a worker type — workerTypeId on CreateWorker.

The list is not paged, and no order is guaranteed — sort client-side if you need one. The values change very rarely, so cache them rather than fetching them before every call.

Access. Requires an authenticated token. No further policy is applied.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json

Every worker type the platform publishes.

object
workerTypes
required

The worker types. Never null.

Array<object>

One worker type in a list.

object
id

The worker type’s identifier. Stable and platform-wide — the same id means the same thing for every agency.

integer format: int16
name

The worker type name, as it appears in Recruso. Up to 50 characters. Unique across all worker types.

string
Example
{
  "workerTypes": [
    {
      "id": 1,
      "name": "Permanent"
    }
  ]
}

401

Section titled “401”

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"
}