User information

Retrieves the profile and account details of the authenticated user associated with the current API key.

Use this endpoint to confirm which user identity is bound to your API credentials — useful for debugging access issues, verifying role assignments, or bootstrapping workflows that need to know the acting user's context before proceeding.

About Get User Info

Every Esper API key is tied to a specific user account within a tenant. This endpoint surfaces that user's full profile, including their role, group memberships, EMM linkage, and account status. It requires no path parameters — the response is scoped entirely to the authenticated caller. This is the canonical way to confirm "who am I?" in the Esper API context.

Key Fields

username — the login identifier for this user

profile.role — the user's assigned role (e.g., Enterprise Admin, Viewer, Group Admin)

profile.enterprise — the enterprise UUID this user belongs to

emm — linked EMM account details, if applicable

is_active — whether this user account is currently enabled

last_login — timestamp of the most recent authenticated session

Common Use Cases

Confirming which user identity is in use before executing sensitive operations

Retrieving the caller's enterprise ID for use in subsequent API calls

Auditing role assignments for an API key owner

Best Practices

Call this endpoint at the start of integrations to validate API key identity and capture the enterprise ID, rather than hardcoding it

Check is_active to ensure the account hasn't been deactivated before proceeding with bulk operations

Use profile.role to conditionally adapt your integration's behavior based on permission level

Workflow

Authenticate with your API key

Call GET /user_info/ to retrieve the caller's identity, enterprise ID, and role

Store profile.enterprise for use as enterprise_id in downstream API calls