Skip to main content
GET
List all identities in the current workspace with optional filtering and pagination.

Authorizations

X-API-Key
string
header
required

API key required for authentication. Add your API key in the X-API-Key header.

Query Parameters

query
string | null

Search identities by their name.

retrieve_accounts
boolean | null

Whether to include associated integrations for each identity. Note: Enabling this will increase response time.

page
integer
default:1

The page number to retrieve (1-based indexing).

Required range: x >= 1

Response

Successfully retrieved users.

workspace_uid
string<uuid>
required
timezone
string
required
type
enum<string>
required
Available options:
standard,
engagement
uid
string<uuid>
created_at
string<date-time>
name
string | null
is_active
boolean
default:false
integrations
string[]