Skip to main content

POST /v2/identities.listIdentities

Get a paginated list of all identities in your workspace. Returns metadata and rate limit configurations. Perfect for building management dashboards, auditing configurations, or browsing your identities.

Required Permissions

Requires identity.*.read_identity permission

Request

integer
Maximum number of identities to return per request.Example: 50
string
Pagination cursor from previous response to fetch next page.Example: cursor_eyJrZXkiOiJrZXlfMTIzNCJ9

Response

array
required
Array of identity objects. Each identity includes:
  • id - Internal identity identifier
  • externalId - Your system’s identifier
  • meta - Custom metadata object
  • ratelimits - Array of rate limit configurations
string
Pagination cursor for fetching the next page (null if no more results).
integer
Total number of identities in the workspace.

Example

cURL
Response

Error Codes

  • 400 - Bad request (invalid parameters)
  • 401 - Unauthorized (missing or invalid root key)
  • 403 - Forbidden (insufficient permissions - requires identity.*.read_identity)
  • 429 - Too many requests (rate limit exceeded)
  • 500 - Internal server error