Search for courses
- 16 Jul 2024
- 3 Minutes to read
- Print
Search for courses
- Updated on 16 Jul 2024
- 3 Minutes to read
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/SearchCourses
Allows you to search for courses.
Security
API Key
Header parameter nameapi_key
Query parameters
pageIndex
integer (int32)
A 0-based index of the paged results you wish to receive. In general, you should start with a value of zero and increment it as you need to retrieve additional results. If not supplied, a value of 0 is used (the first page of results).
pageSize
integer (int32)
Indicates how many results you want per page. if not supplied, a default value of 100 is used.
sort
string
The value you want to sort by. If not supplied, a default value of "Name" will be used. You can append " DESC" after the sort value to sort descending. For example, "Name DESC" would sort by name in descending order. Possible values:
- Name
- Organization
- ContentProvider
- AvailableInstructorLed
- AvailableSelfPaced
name
string
An optional parameter used to filter for courses by name. When specified, only courses that have names that contain or match this value will be returned.
externalId
string
An optional parameter used to filter for courses by external ID
hasLabs
boolean
An optional parameter used to filter for courses that contain labs. If true is passed, only courses with labs are returned. If false is passed, only courses without labs are returned.
createdAfter
string
An optional parameter used to filter for courses created after a specified date. When used in conjunction with the "createdBefore" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
createdBefore
string
An optional parameter used to filter for courses created before a specified date. When used in conjunction with the "createdAfter" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
lastModifiedAfter
string
An optional parameter used to filter for courses modified after a specified date. When used in conjunction with the "lastModifiedBefore" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
lastModifiedBefore
string
An optional parameter used to filter for courses modified before a specified date. When used in conjunction with the "lastModifiedAfter" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
availableInstructorLed
boolean
An optional parameter used to filter for courses that are available instructor-led. If true is passed, only courses that are avaialble instructor-led are returned. If false is passed, only courses that are not available instructor-led are returned.
availableSelfPaced
boolean
An optional parameter used to filter for courses that are available self-paced. If true is passed, only courses that are avaialble self-paced are returned. If false is passed, only courses that are not available self-paced are returned.
Responses
200
OK Response
object
Status
integer (int32)
Indicates the status of the API request.
0 = Success
10 = Error
20 = Not found
30 = Invalid integration key
Example10
Error
string | null
Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).
TotalCount
integer (int32)
The total number of results that match the search conditions, not all of which may be in the current result set.
Example1
TotalPages
integer (int32)
The total number of result pages that match the search conditions.
Example1
Results
Array of object (CourseSearchResult)
See CourseSearchResult.
object
Id
integer (int32)
The unique identifier of the course.
Example4567
ExternalId
string | null
The course assignment's external ID, usually a unique identifier from the calling system.
ExampleFC8D0166-B2F3-4705-8187-5D72BA81F511
Name
string
The name of the course.
ExampleCourse A
Description
string | null
The activity's description
OrganizationId
integer (int32)
The ID of the organization the course belongs to.
Example455
OrganizationName
string
The name of the organization the course belongs to.
ExampleSample Organization
ContentProviderId
integer (int32) | null
The ID of the course content provider.
Example9876
AvailableInstructorLed
boolean
Indicates whether the course is available instructor-led.
ExampleTrue
AvailableSelfPaced
boolean
Indicates whether the course is available self-paced.
ExampleFalse
CustomFields
Array of object (CustomField)
See CustomField
object
Name
string
The name of the custom field.
ExampleMyCustomText
TexValue
string
The value of the custom field.
ExampleWoohoo!
Created
integer (int64)
When the course was created. Provided in Unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
Example1449496820
LastModified
integer (int64)
When the course was last modified. Provided in Unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
Example1584035105
AutoArchiveDate
integer (int64) | null
When the course is scheduled to be archived. Provided in Unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
Example1453024103
Was this article helpful?