v1

latestOpenAPI 3.0.1Apache 2.02026-08-063494581.6 MB
esper_cloud_api_User

Get Users

Returns a paginated list of all users in the tenant, including their profile details, role assignments, and account status.

Use this endpoint to enumerate current tenant members, audit role distributions, or build user-management tooling on top of the Esper platform.

About Get Users

This endpoint retrieves the full set of user records within the authenticated enterprise, returning each user's name, email, role, group memberships, active status, and EMM linkage. Results are paginated with count, next, and previous fields for traversal. Note that POST /user/ (user creation at this same path) is tagged User (Deprecated) — for adding new users, use the invite flow via POST /authn2/v0/tenant/{enterprise_id}/invite instead.

Key Fields (Response)

id — integer ID for the user record

username — the user's login identifier

email — the user's email address

profile.role — assigned role within the enterprise (Enterprise Admin, Viewer, Group Admin, Group Viewer, or AuthZ Role User for custom RBAC assignments)

profile.groups — group UUIDs the user has access to

is_active — whether the account is currently enabled

last_login — most recent authenticated session timestamp

has_emm — whether the user has an associated EMM account

Common Use Cases

Auditing all users and their role assignments across a tenant

Identifying inactive accounts (is_active: false) for deprovisioning

Mapping user IDs to usernames for use in other API calls (e.g., event logs, audit records)

Best Practices

Use this endpoint for read-only enumeration; use the invite endpoint (POST /authn2/v0/tenant/{enterprise_id}/invite) to add new users rather than the deprecated POST /user/

Paginate through next links when the tenant has a large number of users rather than assuming all users appear in the first response

For users with profile.role of AuthZ Role User, their effective permissions are governed by their custom RBAC scope rather than the fixed role set — account for this when building access audits

Workflow

Call GET /user/ to retrieve the first page of tenant users

Follow the next URL in the response until next is null to retrieve all users

Inspect each user's profile.role, is_active, and last_login for access auditing or downstream processing

get/user/

Response

Users List

countinteger
previousstring
nextstring