Get courses

get

https://api.safetyculture.io/training/courses/v1

Retrieves all courses in your organization.

Use this endpoint to fetch course data across your organization. You can apply filters such as the publication status, locale, modification data, or specific IDs.

Query Params

pageSize

int32

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

page

int32

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

modifiedSince

date-time

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

publicationStatus

string

enum

Defaults to PUBLICATION_STATUS_UNKNOWN

[Optional] The publication status of the course.

PUBLICATION_STATUS_UNKNOWN: Unknown publication status
PUBLICATION_STATUS_PUBLISHED: course is published

Allowed:

courseIds

array of strings

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

courseIds

locale

string

[Optional] The preferred locale of the course.

searchTerm

string

[Optional] The search term to filter out courses

groupIds

array of strings

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

groupIds

siteIds

array of strings

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

siteIds

userId

string

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

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.

defaultAn unexpected error response.