Skip to content

List titles

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

Returns every title the platform publishes. A person’s title — Mr, Miss, Mrs and the rest. The same vocabulary serves workers, contact persons and users.

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 title — titleId 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 title the platform publishes.

object
titles
required

The titles. Never null.

Array<object>

One title in a list.

object
id

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

integer format: int16
name

The title name, as it appears in Recruso. Up to 20 characters. Unique across all titles.

string
Example
{
"titles": [
{
"id": 1,
"name": "Mr"
}
]
}

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