Skip to main content
GET
List trainings

Headers

Authorization
string
required

API key. Value must be formatted like so: lucca application={api_key}.

Query Parameters

Find a training from a string. Search is based on title, subtitle and description.

Example:

"French"

providerIds
integer<int32>[]

Filter out trainings by provider ID.

Required range: x >= 1
Example:
categoryIds
integer<int32>[]

Filter out trainings by category ID.

Required range: x >= 1
Example:
id
integer<int32>[]

Filter out trainings based on their id.

fields.root
enum<string>[]

Include the total number of items across all pages, as well as pointers to the previous and next pages.

Available options:
prev,
next,
count
page

Page to retrieve. Either the page index or the page cursor .

Required range: x >= 0
limit
integer
default:20

Pagination: number of items per page.

Required range: 0 <= x <= 100

Response

200 - application/json

OK

count
integer<int32> | null

Total number of items across all pages. You need to include ?fields.root=count to your request to retrieve this.

Required range: x >= 0
prev
string | null

Cursor to the previous page. You need to include ?fields.root=prev in order to retrieve this.

next
string | null

Cursor to the next page. You need to include ?fields.root=next in order to retrieve this.

items
Training · object[]