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. Use ?expand=manager to include manager information grouped by subsidiary. Use ?expand=groups to include the custom user groups the user belongs to. Use ?group= with a group UUID or internal_id to get only the active members of that custom group. Multiple expand parameters can be combined with commas: ?expand=enterprise,cost_centers,manager.

Expandable resources (pass to ?expand=):

OptionWhat it adds
enterpriseAdds the full enterprise object the user belongs to (omitted unless expanded).
cost_centersAdds the cost_centers the user can submit to, grouped by subsidiary (omitted unless expanded).
managerAdds the user's manager per subsidiary (the manager object is null when none is assigned).
groupsAdds the custom user groups the user is an active member of (omitted unless expanded).
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Id of the selected enterprise

Query Params
string
expand
array of strings

Related resources to inline. Combine multiple with commas, e.g. ?expand=enterprise,cost_centers. Available options: enterprise, cost_centers, manager, groups. By default these come back as <field>_id references (or are omitted); expanding replaces them with the full nested object.

expand
Allowed:
string

Filter users that are active members of a custom group, by the group UUID or internal_id

integer

A page number within the paginated result set.

integer

Number of results to return per page.

string
string
enum

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

Allowed:
Responses

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