Skip to main content
GET
Retrieve qualifications

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

filter
string
default:""
sort
enum<string>[]

A comma separated list of fields to sort by.

Available options:
title,
-title,
level,
-level,
created_at,
-created_at
include
enum<string>[]

A comma separated list of related resources to include.

Available options:
awarding_body
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

Response

Get a list of qualifications.

JSON API response object

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

Related resources that can be included when a qualification is returned