v2

latestOpenAPI 3.0.3Apache-2.02026-08-07119359591.9 KB
Users

List users

List users in the account with cursor-based pagination. Results are sorted by creation date ascending (oldest first).

Requires account admin role, account member role, or USER_READ permission at the account level.

<Note>This endpoint is in beta, read more here.</Note>

get/v2/users

Query parameters

limitinteger

Maximum items to return

cursorstring

Opaque pagination cursor returned from a previous response (pagination.next_cursor). Treat it as an unreadable token; do not attempt to parse or construct it.

emailstring

Filter users by email address (case-insensitive partial match, up to 255 characters). Results are scoped to users visible to the caller.

statusUserStatus[]

Filter users by account status. When omitted, ACTIVE, INVITED, and EXPIRED users are returned. Can be specified multiple times to filter by multiple statuses (e.g., ?status=ACTIVE&status=INVITED).

Response

Returns a list of account user objects

Example response

{
  "users": [
    {
      "id": "RW50aXR5OjEyMzQ1",
      "email": "user@example.com",
      "role": {
        "id": "RW50aXR5OjEyMzQ1"
      }
    }
  ]
}