Get Users details

Retrieves the list of users belonging to the tenant.

Returns each user's UsersListResponse record, including their UUID-format user_id, email, name, and the connection they authenticated through. Optionally filter by a legacy integer user ID for cross-referencing against older user records.

About Get Users

This is the current, supported endpoint for listing users in a tenant, and it returns the UUID-format identifier (user_id) needed for other user-management endpoints such as Update User Role, which requires an authn_user_id in UUID format. This UUID is distinct from the integer id returned by the older GET /user/ endpoint; use this endpoint whenever a downstream call requires the UUID form.

Key Fields / Query Parameters

legacy_user_id — an optional integer filter for cross-referencing against the older, integer-based user id from GET /user/

Common Use Cases

Retrieving a user's UUID before calling Update User Role or another endpoint that requires authn_user_id

Auditing the full list of users in a tenant along with their email and connection

Cross-referencing a legacy integer user id against its corresponding UUID

Best Practices

Always retrieve the UUID form of a user's id from this endpoint before calling endpoints that require authn_user_id, rather than assuming the integer id from GET /user/ will work

Use legacy_user_id when migrating scripts that were written against the older integer-based user id

Workflow

Call this endpoint to list users, optionally filtering by legacy_user_id

Capture the user_id (UUID) for the target user

Use that UUID in downstream calls such as Update User Role This endpoint allows to fetch user list of a tenant