List courses
List of courses that can be offered to a contact or purchased
Pagination
Use the page[number] and page[size] query parameters to paginate results:
Get first page of 10 items
GET /v1/courses?page[number]=1&page[size]=10
Get second page of 25 items
GET /v1/courses?page[number]=2&page[size]=25
The response includes pagination links and meta data:
Sorting
Use the sort parameter to sort the results:
Sort by title in ascending order
GET /v1/courses?sort=title
Sort by title in descending order
GET /v1/courses?sort=-title
Response will include courses sorted by the specified field
Sparse Fields
Use the fields parameter to request only specific attributes:
Only return title and thumbnail_url attributes
GET /v1/courses?fields[courses]=title,thumbnail_url
Response will only include requested fields
Filter by Site ID
Use the filter[site_id] parameter to get courses for a specific site:
Get courses for site with ID 123
GET /v1/courses?filter[site_id]=123
Response will only include courses for that site
Filter by Title Contains
Use the filter[title_cont] parameter to find courses where the title contains specific text:
Get courses with titles containing “marketing”
GET /v1/courses?filter[title_cont]=marketing
Response will include courses with matching titles
Filter by Description Contains
Use the filter[description_cont] parameter to find courses where the description contains specific text:
Get courses with descriptions containing “marketing”
GET /v1/courses?filter[description_cont]=marketing
Response will include courses with matching descriptions
Using Multiple Parameters Together
You can combine pagination, sparse fields, filtering and sorting in a single request:
Get first page of 10 courses for site 123, sorted by title, showing only specific fields
GET /v1/courses?page[number]=1&page[size]=10&filter[site_id]=123&sort=title&fields[courses]=title,thumbnail_url
Response will include pagination, sorted filtered results with requested fields
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Sort order, use: title, for descending order use '-' e.g. &sort=-title
Number of documents
Partial attributes as specified, e.g. fields[courses]=title,thumbnail_url
Filter by site_id, for example ?filter[site_id]=111
Filter by title contains, for example ?filter[title_cont]=marketing
Filter by description contains, for example ?filter[description_cont]=marketing
Filter by publish status, for example ?filter[publish_status_eq]=published