Skip to main content
GET
/
v1
/
users
List users
curl --request GET \
  --url https://api.example.com/v1/users

Documentation Index

Fetch the complete documentation index at: https://docs.hawkings.education/llms.txt

Use this file to discover all available pages before exploring further.

Query

role
enum
workspace_id
string
cohort_id
string
Restrict to users enrolled in a cohort.
email
string
Exact-match lookup.
limit
integer
default:"20"
starting_after
string

Examples

const teachers = await hk.users.list({ role: "teacher" });
const cohort   = await hk.users.list({ cohort_id: "coh_123" });

Returns

A paginated list of Users.