SKskilljar
Published Courses

List published courses

Changed on

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

Required OAuth scope: published-courses:read

get/v2/published-courses/

Request

Query parameters

filter[domain]string nullable

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.

filter[live]boolean nullable

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

includestring nullable

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

page[size]integer

Maximum number of records to return.

page[cursor]string nullable

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

Response

OK

metaobject nullable

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

includedobject[] nullable

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

Changes

  • bed169429eb2Revision changes
    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added to the response property anyOf list for the response status

    • info

      removed subschema #1 from the response property anyOf list for the response status

  • 9fc34e55336dRevision changes
    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status