Users API reference

Reference map for Users API operations.

Updated
Apr 26, 2026

Users

Use this reference map to choose the operation group before opening an endpoint page for exact request and response details.

Use Users when the job is Auth API customer/account identity lookup, current-user reads, current-user updates, deletion, or user attribute relationships.

Current-user routes operate from the token context. Lookup and user-id routes operate by email or user ID within the app. Attribute relationship routes attach or remove an existing attribute from a user.

Use Merchant Users when the job is trusted administration of merchant-facing users. Use Organisations when the user relationship is scoped to an organisation in Auth API context.

For workflow guidance across Management Organizations, Auth Organisations, Merchant Users, Users, attributes, customer groups, and events, see Organizations and account access.

Read and inspect

OperationAPI
Get user by IDAuth API
Lookup user by emailAuth API

Update or repair

OperationAPI
Update user by IDAuth API

Remove or deactivate

OperationAPI
Delete current userAuth API

Other operations

Users API reference

# Users Use this reference map to choose the operation group before opening an endpoint page for exact request and response details. Use Users when the job is Auth API customer/account identity lookup, current-user reads, current-user updates, deletion, or user attribute relationships. Current-user routes operate from the token context. Lookup and user-id routes operate by email or user ID within the app. Attribute relationship routes attach or remove an existing attribute from a user. Use Merchant Users when the job is trusted administration of merchant-facing users. Use Organisations when the user relationship is scoped to an organisation in Auth API context. For workflow guidance across Management Organizations, Auth Organisations, Merchant Users, Users, attributes, customer groups, and events, see [Organizations and account access](/start/concepts/organizations-and-account-access).

6 operations grouped by the job they support.

## Read and inspect | Operation | API | | --- | --- | | [Get user by ID](/reference/users/get-user-by-id) | Auth API | | [Lookup user by email](/reference/users/lookup-user-by-email) | Auth API | ## Update or repair | Operation | API | | --- | --- | | [Update user by ID](/reference/users/update-user-by-id) | Auth API | ## Remove or deactivate | Operation | API | | --- | --- | | [Delete current user](/reference/users/delete-current-user) | Auth API | ## Other operations | Operation | API | | --- | --- | | [Gets the user from the token](/reference/users/gets-the-user-from-the-token) | Auth API | | [Updates the user information](/reference/users/updates-the-user-information) | Auth API |