v1

latestOpenAPI 3.1.02026-07-263911,4691.1 MB
Training

Get courses

Retrieves all courses in your organization.

get/training/courses/v1

Query parameters

pageSizeinteger

[Optional] The number of items to return. Defaults to 25. You can specify a value between 1 to 1000.

pageinteger

[Optional] The current page number. Default to 1. Must be at least 1.

modifiedSincestring date-time

[Optional] The The minimum modified date of the course.

publicationStatus'PUBLICATION_STATUS_UNKNOWN' | 'PUBLICATION_STATUS_PUBLISHED'

[Optional] The publication status of the course.

  • PUBLICATION_STATUS_UNKNOWN: Unknown publication status
  • PUBLICATION_STATUS_PUBLISHED: course is published
courseIdsstring[]

[Optional] Filter by specific course IDs. If empty, all courses matching other filters will be returned.

localestring

[Optional] The preferred locale of the course.

searchTermstring

[Optional] The search term to filter out courses

groupIdsstring[]

[Optional] Filter by assigned group IDs. If empty, all courses matching other filters will be returned.

siteIdsstring[]

[Optional] Filter by assigned site IDs. If empty, all courses matching other filters will be returned.

userIdstring

[Optional] Filter by a users enrolled Courses. If empty, all courses matching other filters will be returned.

Response

A successful response.

totalCountinteger

The total number of courses matching the request