Get marital status details
GET
/v1/reference/marital-statuses/{id}
const url = 'https://api2.recruso.co.uk/v1/reference/marital-statuses/1';const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api2.recruso.co.uk/v1/reference/marital-statuses/1 \ --header 'Authorization: <Authorization>'Returns one marital status by id. A worker’s marital status.
Marital statuses are platform-wide, so an id means the same marital status for every agency.
An id that does not match a marital status returns 404.
Access. Requires an authenticated token. No further policy is applied.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
integer format: int32
The id path parameter
Responses
Section titled “Responses”OK
Media typeapplication/json
One marital status.
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
{ "id": 1, "name": "Single"}Unauthorized
Media typeapplication/problem+json
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
Media typeapplication/problem+json
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}