Users list

List all available users from my enterprise. Supports filtering by status (active/inactive) and expanding related data. Use ?status=active to get only active users (users with cost center permissions). Use ?status=inactive to get only inactive users (users without cost center permissions). Use ?expand=enterprise to include enterprise details in the response. Use ?expand=cost_centers to include cost centers grouped by subsidiary. Multiple expand parameters can be combined with commas: ?expand=enterprise,cost_centers.

Path Params
string
required
Defaults to v1

Api version

string
required

Id of the selected enterprise

Query Params
string
enum

Filter users by status: 'active' (has allocations) or 'inactive' (no allocations)

Allowed:
string

Expand related resources. Available options: 'enterprise', 'cost_centers'. Use 'enterprise' to include enterprise details. Use 'cost_centers' to include cost centers grouped by subsidiary. Multiple values can be comma-separated (e.g., 'enterprise,cost_centers').

string

Filter by exact email address (case-sensitive)

string

Filter by phone number (with or without + prefix)

integer

A page number within the paginated result set.

integer

Number of results to return per page.

Responses

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