Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

filter
string
required

Filters the records listed.

  • eq(organisation,xxx): Required. The organisation whose members' records are listed.
  • ge(expires_at,xxx) and le(expires_at,xxx): the expiry window. Without ge, records that have already expired are included.
  • in(type,[xxx,yyy]): the record types. One of qualification, training, induction, assessment, registration, scheme_registration or category_registration.
  • in(job_role,[xxx,yyy]): records required by at least one of these job roles.
  • in(risk,[xxx,yyy]): the risk bands. One of critical, high, medium, low or none. critical means expired.
  • contains(name,xxx): the person's name or email. Every word must match.

A filter term this endpoint does not recognise, or one given more than once, is rejected with a 400 rather than ignored. expires_at takes one ge and one le.

For more information on using named filters, see the docs

Minimum string length: 1
sort
enum<string>[]

The field to order the records by. One field only.

Defaults to expires_at, the soonest expiry first. risk orders by severity, from critical down to none, and soonest expiry first within a band.

Maximum array length: 1
Available options:
expires_at,
-expires_at,
risk,
-risk
include
enum<string>[]

A comma separated list of related resources to include.

Available options:
user
limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0
page
object

JSON:API pagination, as page[limit] and page[offset]. The same as the top-level limit and offset parameters; when both forms are sent, page[...] wins.

format
enum<string>

Asks for the CSV export rather than a page of records. The export exists as a plain URL so a browser download can use it without setting a header.

Available options:
csv

Response

A page of expiring competency records, or the whole filtered set as CSV when format=csv was asked for.

JSON API response object

data
A list of expiring competency records · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

Related resources that can be included when an expiring competency record is returned