Students

List students

List students for the authenticated organization.

Required OAuth scope: students:read

get/v2/students/

Request

Base URL
https://api.skilljar.com (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/skilljar/apis/skilljar-api-v2/docs/v2/students/get.ts
A function with typed inputs. Its response is checked against the schema.

filter[email]string nullable

Exact email match (case-insensitive).

filter[first_name]string nullable

Exact first name match.

filter[last_name]string nullable

Exact last name match.

filter[is_inactive]boolean nullable

Filter by active/inactive status.

page[size]integer

Maximum number of records to return.

page[cursor]string nullable

Opaque cursor from the previous page's links.next.

metaobject nullable

Pagination metadata, e.g. {"page_size": 25}.

includedobject[] nullable

Related resources requested via ?include=. Absent when no include was requested.