latestOpenAPI 3.1.02026-08-1182263351.1 KB

f8025de20169

Published Courses

List published courses

List the organization's published courses (live and unpublished by default).

Required OAuth scope: published-courses:read

get/v2/published-courses/

Query parameters

filter[domain]string nullable

Opaque domain id. Returns only published courses on that domain. Unknown ids match nothing.

Opaque domain id. Returns only published courses on that domain. Unknown ids match nothing.

filter[course]string nullable

Opaque course id. Returns only published courses for that course. Unknown ids match nothing.

Opaque course id. Returns only published courses for that course. Unknown ids match nothing.

filter[live]boolean nullable

Filter by published (live) state. Omit to return both live and unpublished rows.

Filter by published (live) state. Omit to return both live and unpublished rows.

includestring nullable

Comma-separated related resources to include. Supported: course, domain.

Comma-separated related resources to include. Supported: course, domain.

page[size]integer

Maximum number of records to return.

Maximum number of records to return.

page[cursor]string nullable

Opaque cursor from the previous page's links.next.

Opaque cursor from the previous page's links.next.

Response

OK

metaobject nullable

Pagination metadata, e.g. {"page_size": 25}.

linksobject nullable

Pagination links, e.g. {"self": "...", "next": "...", "prev": null}.

has_moreboolean required

Whether additional pages exist after this one.

next_cursorstring nullable

Opaque cursor to pass as page[cursor] for the next page; null on the last page.

includedobject[] nullable

Related resources requested via ?include=. Absent when no include was requested.