CrystalQore
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.

Permissionusers
User headerOptional

Query

NameTypeDescription
searchstringName, email, or extension
includePresencebooleanAttach a presence block when true
limit / offsetnumberSee 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.

curl -sS "https://app.crystalqore.com/api/v1/users?includePresence=true&limit=20" \
  -H "X-API-Key: $CRYSTALQORE_API_KEY" \
  -H "X-Tenant-Id: $CRYSTALQORE_TENANT_ID"

Try it in the playground.

On this page