Groups

List visibility overrides for a group

Changed on

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/

Request

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.

filter[is_visible]boolean nullable

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.

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

    • breaking

      removed the required property /// from the response with the status

    • 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 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

    • info

      added the required property /// to the response with the 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