latestOpenAPI 3.1.02026-08-1182263351.1 KB

f8025de20169

Groups

List visibility overrides for a group

Cursor-paginated list of visibility overrides for the given group.

Supported filters (all optional):

  • filter[published_course_id]: obfuscated id. Undecodable or cross-organization ids return an empty page, never an error.
  • filter[is_visible]: true returns only allowlist rows, false returns only blocklist rows; omitting the filter returns both.

Pagination (page[size], page[cursor]) is read from request by CursorPaginator — the filters argument is consumed for the filter[*] query params only.

Returns 404 if the group does not exist in the caller's organization (document-level — distinct from per-item not_found on POST/DELETE, which surfaces inside a 207 envelope).

Required OAuth scope: student-groups:read

get/v2/groups/{id}/relationships/published-course-visibility/

Path parameters

idstring required

Query parameters

filter[published_course_id]string nullable

Obfuscated id of a PublishedCourse. Returns only overrides targeting that course. Undecodable or cross-organization ids return zero results, never an error.

Obfuscated id of a PublishedCourse. Returns only overrides targeting that course. Undecodable or cross-organization ids return zero results, never an error.

filter[is_visible]boolean nullable

True returns only allowlist overrides (force visible); False returns only blocklist overrides (force hidden); omitting the filter returns both.

True returns only allowlist overrides (force visible); False returns only blocklist overrides (force hidden); omitting the filter returns both.

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.