List Identities

client.identities.list(?, ?): ArrayPage<Identity { id, agent_ids, block_ids, 5 more } >

get/v1/identities/

Get a list of all identities in the database

ParametersExpand Collapse

query: IdentityListParams { after, before, identifier_key, 6 more }

after?: string | null

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

before?: string | null

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

identifier_key?: string | null

identity_type?: IdentityType | null

Enum to represent the type of the identity.

Accepts one of the following:

"org"

"user"

"other"

limit?: number | null

Maximum number of identities to return

name?: string | null

order?: "asc" | "desc"

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

Accepts one of the following:

"asc"

"desc"

order_by?: "created_at"

Field to sort by

Accepts one of the following:

"created_at"

project_id?: string | null

ReturnsExpand Collapse

Identity { id, agent_ids, block_ids, 5 more }

id: string

The human-friendly ID of the Identity

Deprecatedagent_ids: Array<string>

The IDs of the agents associated with the identity.

Deprecatedblock_ids: Array<string>

The IDs of the blocks associated with the identity.

identifier_key: string

External, user-generated identifier key of the identity.

identity_type: IdentityType

The type of the identity.

Accepts one of the following:

"org"

"user"

"other"

name: string

The name of the identity.

project_id?: string | null

The project id of the identity, if applicable.

properties?: Array<IdentityProperty { key, type, value } >

List of properties associated with the identity

key: string

The key of the property

type: "string" | "number" | "boolean" | "json"

The type of the property

Accepts one of the following:

"string"

"number"

"boolean"

"json"

value: string | number | boolean | Record<string, unknown>

The value of the property

Accepts one of the following:

string

number

boolean

Record<string, unknown>

List Identities

import Letta from '@letta-ai/letta-client';

const client = new Letta({
  apiKey: 'My API Key',
});

// Automatically fetches more pages as needed.
for await (const identity of client.identities.list()) {
  console.log(identity.id);
}

[
  {
    "id": "identity-123e4567-e89b-12d3-a456-426614174000",
    "agent_ids": [
      "string"
    ],
    "block_ids": [
      "string"
    ],
    "identifier_key": "identifier_key",
    "identity_type": "org",
    "name": "name",
    "project_id": "project_id",
    "properties": [
      {
        "key": "key",
        "type": "string",
        "value": "string"
      }
    ]
  }
]

Returns Examples

[
  {
    "id": "identity-123e4567-e89b-12d3-a456-426614174000",
    "agent_ids": [
      "string"
    ],
    "block_ids": [
      "string"
    ],
    "identifier_key": "identifier_key",
    "identity_type": "org",
    "name": "name",
    "project_id": "project_id",
    "properties": [
      {
        "key": "key",
        "type": "string",
        "value": "string"
      }
    ]
  }
]