SKskilljar
Groups

List groups

Changed on

List student groups for the authenticated organization.

Required OAuth scope: student-groups:read

get/v2/groups/

Request

Query parameters

filter[name]string nullable

Case-insensitive substring match on group name. Backed by a sequential scan inside the caller's organization; expected typical org cardinality is < 1k groups.

filter[category_id]string nullable

Obfuscated id of a StudentGroupCategory. Returns only groups in that category. Undecodable or cross-organization ids return zero results, never an error.

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

    • 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

  • 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