Skip to content
Recruso API

List marital statuses

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

Returns every marital status the platform publishes. A worker’s marital status.

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 marital status — maritalStatusId 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 marital status the platform publishes.

object
maritalStatuses
required

The marital statuses. Never null.

Array<object>

One marital status in a list.

object
id

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

integer format: int16
name

The marital status name, as it appears in Recruso. Up to 20 characters. Unique across all marital statuses.

string
Example
{
  "maritalStatuses": [
    {
      "id": 1,
      "name": "Single"
    }
  ]
}

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