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(id,xxx): Filter training items by ID.
  • eq(name,xxx): Filter training items by name.
  • contains(name,xxx): Filter training items where name contains value.
  • eq(organisation,xxx): Filter training items by organisation ID.
  • eq(created_at,xxx): Filter training items by created date.

For more information on using named filters, see the docs

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 training items.

JSON API response object

data
A list of training items · object[]
required
meta
object
required
jsonapi
object
required