Skip to content

Get client type details

GET
/v1/reference/client-types/{id}
curl --request GET \
--url https://api2.recruso.co.uk/v1/reference/client-types/1 \
--header 'Authorization: <Authorization>'

Returns one client type by id. Recruso separates live clients from prospective ones. The client endpoints resolve the type named Live themselves and the lead endpoints resolve their own, so you never send a client type on a request.

Client types are platform-wide, so an id means the same client type for every agency.

An id that does not match a client type returns 404.

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

id
required
integer format: int32

The id path parameter

OK

Media typeapplication/json

One client type.

object
id

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

integer format: int16
name

The client type name, as it appears in Recruso. Up to 50 characters. Unique across all client types.

string
Examplegenerated
{
"id": 1,
"name": "example"
}

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

Not Found

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