The Users API allows tenant administrators to list existing users and invite new ones. User creation uses a privacy-safe response that does not reveal whether an email is already registered.
Base path
List users
Returns a paginated list of users for the current tenant, ordered by creation date (newest first). Only returns non-sensitive fields.
Query parameters
Response 200
Invite a user
Creates a new user account for the tenant. If the email is already registered, the response is identical to a successful creation to prevent email enumeration.
Request body
Example request
Response 201
The response message is intentionally vague for security. The same 201 status and message is returned regardless of whether the user already existed.
Error codes
Update a user
Updates an existing user’s name or role.
Path parameters
Request body
All fields are optional. Only include the fields you want to change.
Example request
Response 200
Returns the full updated user object.
Delete a user
Permanently deletes a user from the tenant.
Path parameters
Response 204
No content. The user has been deleted.
Error codes
Role requirements