Sign in
latestOpenAPI 3.1.02026-08-1182263351.1 KB

f8025de20169

Groups

List groups

List student groups for the authenticated organization.

Required OAuth scope: student-groups:read

get/v2/groups/

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.

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.

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.

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.