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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

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
string
enum

This endpoint can produce either JSON or XML.

Allowed:
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized. The API key is missing or invalid.

403

Forbidden. The caller does not have permission to access this endpoint.

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json