Skip to content
Recruso API

List subcontractor status types

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

Returns every subcontractor status type the platform publishes. The statuses a subcontractor can be held under. Archived is the only one defined today.

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. No endpoint published on this API takes a subcontractor status type id yet; the vocabulary is published so that its values are enumerable.

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 subcontractor status type the platform publishes.

object
subContractorStatusTypes
required

The subcontractor status types. Never null.

Array<object>

One subcontractor status type in a list.

object
id

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

integer format: int16
name

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

string
Example
{
  "subContractorStatusTypes": [
    {
      "id": 1,
      "name": "Active"
    }
  ]
}

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