Skip to main content
GET
List verifications

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:

  • eq(id,xxx): Filter verifications by ID.
  • eq(organisation,xxx): Filter verifications by verifying organisation ID.
  • eq(author,xxx): Filter verifications by the author (verifier) user ID.
  • eq(ref_type,xxx): Filter verifications by the ref resource type (induction-completions, training-completions, assessment-records, registrations, category-registrations, scheme-registrations).
  • eq(ref_id,xxx): Filter verifications by the ref resource ID.
  • eq(verified_at,xxx): Filter verifications by the verification timestamp.
  • eq(created_at,xxx): Filter verifications by created date.

For more information on using named filters, see the docs

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
author,
organisation,
induction_completion,
training_completion,
assessment_record,
registration,
category_registration,
scheme_registration
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 verifications.

JSON API response object

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

Related resources that can be included when a verification is returned

A user