Skip to content

List a worker's Driver CPC entitlements

GET
/v1/workers/{workerId}/cpc-licence-categories
curl --request GET \
--url https://api2.recruso.co.uk/v1/workers/1/cpc-licence-categories \
--header 'Authorization: <Authorization>'

Returns every Driver CPC entitlement recorded for a worker in your own agency, earliest start date first.

Expired entitlements are listed alongside current ones: the record keeps them, and validUntil on each says which is which. A class can appear more than once — each renewal is its own period. The list is not paged.

A worker id belonging to another agency returns 404 rather than 403, so their existence is never disclosed.

Access. Requires a client-credentials access token. Tokens issued through the interactive user login are rejected.

workerId
required
integer format: int32

The workerId path parameter

OK

Media typeapplication/json

Every Driver CPC entitlement recorded for a worker.

object
workerId

The worker the entitlements belong to.

integer format: int32
cpcLicenceCategories

The entitlements, earliest start date first.

Array<object>

A vehicle class the worker holds Driver CPC entitlement for.

object
driverCpcLicenceCategoryId

The record’s identifier.

integer format: int64
vehicleCategoryId

The vehicle class, as an id from the platform Vehicle categories vocabulary.

integer format: int16
validFrom

The date the entitlement starts.

string format: date
validUntil

The date the entitlement runs to.

string format: date
Example
{
"workerId": 4821,
"cpcLicenceCategories": [
{
"driverCpcLicenceCategoryId": 3310,
"vehicleCategoryId": 2,
"validFrom": "2021-09-10",
"validUntil": "2026-09-09"
}
]
}

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

Forbidden

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