Skip to main content
Example
{
  "id": "usr_01HX9N5AB3...",
  "object": "user",
  "email": "ada@example.edu",
  "name": "Ada Lovelace",
  "role": "student",
  "workspace_id": "wks_01HX9...",
  "external_id": "canvas_user_42",
  "metadata": { "graduation_year": 2028 },
  "enabled": true,
  "created_at": "2026-05-10T12:00:00Z"
}

​
Attributes

​
id
string
Prefix usr_.
​
email
string
​
name
string
​
role
enum
student | teacher | manager | admin.
​
workspace_id
string
​
external_id
string | null
Your LMS’ user ID.
​
metadata
object
​
enabled
boolean

​
Sugar resources

hk.students.list({ cohort_id: cohortId });   // role: "student"
hk.teachers.list({ cohort_id: cohortId });   // role: "teacher"

$hk->students->list(['cohort_id' => $cohortId]);   // role: "student"
$hk->teachers->list(['cohort_id' => $cohortId]);   // role: "teacher"