Get all users

Returns a paginated list of users for the current customer. Requires user:read or usermanagement.read.

Request

GET /user

Query Parameters

Parameter	Type	Default	Description
`q`	string	`""`	Filter by email (`phrase` match).
`_start`	integer	`0`	Pagination offset.
`_end`	integer	`20`	End index (exclusive). Page size is `_end - _start`.
`_sort`	string	`email`	Sort field (for example `email`).
`_order`	string	`ASC`	`ASC` or `DESC`.
`filterByRole`	string	—	Auth0 role ID. Empty string is ignored.
`filterByInstance`	string	—	Instance identifier. Empty string is ignored.

Headers

Header	Value
`Authorization`	`Bearer <token>` (or HMAC headers, see Authentication)

Response

JSON array of users. Total count is in the X-Total-Count header.

Response Body

Field	Type	Description
`user_id`	string	Identity-provider user ID (for example `auth0\|…`).
`email`	string	Email address.
`new_user`	boolean	`true` if the user has not completed first login.
`is_external_sso`	boolean	`true` when `user_id` does not contain `auth0\|`.
`instances`	object	Map of instance id (or `"*"`) to arrays of role IDs.

Example Response

[
  {
    "user_id": "auth0|abc123",
    "email": "[email protected]",
    "new_user": false,
    "is_external_sso": false,
    "instances": {
      "*": ["rol_xyz"]
    }
  }
]