v1
latestOpenAPI 3.1.02026-07-26294215839.4 KBList Users
Returns all users for the company, optionally filtered by status. Each user entry includes a user ID, associated employee ID, name, email address (resolved in priority order: work, home, account), account status, and last login time when available.
Pass a comma-separated list of status values via the status query parameter to filter results. Valid values are enabled and disabled. If the parameter is omitted or contains only unrecognized values, users of all statuses are returned. Support admin accounts are always excluded from the response.
The response format is determined by the Accept request header. Send Accept: application/json to receive JSON; omit the header or send any other value to receive XML.
OAuth Scopes: user
Query parameters
Comma-separated list of statuses to filter by. Valid values: enabled, disabled. Defaults to returning users of all statuses when omitted or when no recognized value is provided.
Headers
This endpoint can produce either JSON or XML.
Response
An object whose keys are user IDs (as strings) and whose values are user objects. When the Accept header requests XML, a <users> document is returned instead.
Object keyed by user ID. Each key is a user ID string; each value is a user object.