identities

List Identities

Get a list of all identities in the database

get/v1/identities/

Request

namestring nullable

project_idstring nullable

identifier_keystring nullable

identity_type'org' | 'user' | 'other'

Enum to represent the type of the identity.

beforestring nullable

Identity ID cursor for pagination. Returns identities that come before this identity ID in the specified sort order

afterstring nullable

Identity ID cursor for pagination. Returns identities that come after this identity ID in the specified sort order

limitinteger nullable

Maximum number of identities to return

order'asc' | 'desc'

Sort order for identities by creation time. 'asc' for oldest first, 'desc' for newest first

order_by'created_at'

Field to sort by

Successful Response

idstring

The human-friendly ID of the Identity

identifier_keystring required

External, user-generated identifier key of the identity.

namestring required

The name of the identity.

identity_type'org' | 'user' | 'other' required

Enum to represent the type of the identity.

project_idstring nullable

The project id of the identity, if applicable.

agent_idsstring[] required

The IDs of the agents associated with the identity.

block_idsstring[] required

The IDs of the blocks associated with the identity.

[
  {
    "id": "identity-123e4567-e89b-12d3-a456-426614174000"
  }
]

No recorded changes to this operation across all 36 revisions of this API.