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:

  • eq(organisation,xxx): Filter assessments by organisation ID.
  • eq(user,xxx): Filter assessments by user ID.
  • eq(assessment_definition,xxx): Filter assessments by assessment definition ID.
  • eq(status,xxx): Filter assessments by status (passed/failed).

For more information on using named filters, see the docs

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
organisation,
user,
assessment_definition,
assessor
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 assessments.

JSON API response object

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

Related resources that can be included when an assessment is returned

An organisation