Skip to content

List nationalities

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

Returns every nationality the platform publishes. A worker’s nationality.

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 nationality — nationalityId 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.

OK

Media typeapplication/json

Every nationality the platform publishes.

object
nationalities
required

The nationalities. Never null.

Array<object>

One nationality in a list.

object
id

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

integer format: int16
name

The nationality name, as it appears in Recruso. Up to 50 characters. Unique across all nationalities.

string
Example
{
"nationalities": [
{
"id": 1,
"name": "British"
}
]
}

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