Students

List a student's domain memberships

Changed on

List the domain memberships for a single student, cursor-paginated.

Returns 404 if the student is not in the caller's organization.

Required OAuth scope: students:read

get/v2/students/{id}/relationships/domain-memberships/

Request

Path parameters

idstring required

Query parameters

filter[active]boolean nullable

Filter by active/inactive membership.

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

    • 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

      endpoint added