Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • in(id,[xxx]): Filter qualification awards by ID(s)
  • in(organisation,[xxx]): Filter qualification awards by organisation ID(s)
  • in(qualification,[xxx]): Filter qualification awards by qualification ID(s)
  • in(risk,[xxx]): Filter qualification awards by risk level(s)
  • latest_only: Filter qualification awards to only include the latest awards (useful when awards are renewable)
  • in(user,[xxx]): Filter qualification awards by user ID(s)

For more information on using named filters, see the docs

sort
enum<string>[]

A comma separated list of fields to sort by.

Available options:
risk_status,
-risk_status,
awarded_at,
-awarded_at,
expires_at,
-expires_at,
created_at,
-created_at
include
enum<string>[]

A comma separated list of related resources to include.

Available options:
organisation,
user,
author,
folder,
qualification,
renews,
renewed_by,
assessments
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.

Response

Get a list of Qualification Awards.

JSON API response object

data
A list of qualification awards · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

Related resources that can be included when a qualification award is returned

An organisation