Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

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
include
enum<string>[]

A comma separated list of related resources to include.

Available options:
verifier,
holder,
organisation,
award,
qualification
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • organisation: Filter assessments by organisation ID(s)
  • status: Filter assessments by status (valid, invalid)
  • award: Filter assessments by qualification award ID(s)
  • qualification: Filter assessments by qualification ID(s)
  • verifier: Filter assessments by verifier ID(s)
  • holder: Filter assessments by holder 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:
status,
-status,
verification_date,
-verification_date,
created_at,
-created_at

Response

Get a list of qualification verifications.

JSON API response object

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

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

An organisation