Get subcontractor status type details

GET

/v1/reference/sub-contractor-status-types/{id}

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

• Production

Returns one subcontractor status type by id. The statuses a subcontractor can be held under. Archived is the only one defined today.

Subcontractor status types are platform-wide, so an id means the same subcontractor status type for every agency.

An id that does not match a subcontractor status type returns 404.

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

Authorizations

• Bearer

Parameters

Path Parameters

id

required

integer format: int32

The id path parameter

Responses

200

OK

Media typeapplication/json

One subcontractor status type.

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

{
  "id": 1,
  "name": "Active"
}

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

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