latestOpenAPI 3.1.02026-08-1182263351.1 KB

f8025de20169

Students

List students

List students for the authenticated organization.

Required OAuth scope: students:read

get/v2/students/

Query parameters

filter[email]string nullable

Exact email match (case-insensitive).

Exact email match (case-insensitive).

filter[first_name]string nullable

Exact first name match.

Exact first name match.

filter[last_name]string nullable

Exact last name match.

Exact last name match.

filter[is_inactive]boolean nullable

Filter by active/inactive status.

Filter by active/inactive status.

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.