List users

Retrieve a paginated list of users for the current school.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1

Page number (default: 1, min: 1)

integer
1 to 100

Items per page (default: 25, min: 1, max: 100)

string

Sort key (id, name, email, created_at, updated_at, last_sign_in_at)

string

Sort direction (asc, desc)

string

Filter by user name

string

Filter by user email

string

Filter by user role. Allowed values: owner, author, affiliate, student, custom. Returns empty results for unrecognized values.

string

Filter users created before this ISO8601 datetime. Date range between created_after and created_before cannot exceed 90 days.

string

Filter users created after this ISO8601 datetime. Date range between created_after and created_before cannot exceed 90 days.

string

Filter by user id

Headers
string
required

Generated Admin API key

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json