Skip to main content
GET
Retrieve a paginated list of end users in your project. To look up the end user associated with an identifier from your system, filter the collection by external_id.

Authentication

Requires an API key with end_users:read scope.

Query Parameters

integer
default:"20"
Maximum number of items to return (1-100).
string
Cursor returned by the previous page. See Pagination.
string
Return the active end user whose external_id exactly matches this value. The lookup is scoped to the authenticated project and returns at most one item.

Look up by external ID

cURL
An exact match returns the end user in the standard collection response:
200
When no active end user in the project matches, data is empty:
200
The lookup never reveals whether the same external_id exists in another project. A missing, deleted, or inaccessible end user produces the same empty result.

Response

Returns a paginated list of end user objects.

Response Fields

Each end user object in data contains: