DevelopersAPI Reference
Users
List enabled users in a tenant. Optionally attach presence.
Users
GET /api/v1/users lists enabled users in the tenant identified by X-Tenant-Id.
| Permission | users |
| User header | Optional |
Query
| Name | Type | Description |
|---|---|---|
search | string | Name, email, or extension |
includePresence | boolean | Attach a presence block when true |
limit / offset | number | See pagination |
Response data
data.users[] includes id, firstName, lastName, name, email, extension, phone, title, department, avatar, and role. With includePresence=true, each user also has presence.status, presence.message, and presence.lastSeen.
Try it in the playground.