List Identities

get/v1/identities/

Get a list of all identities in the database

Query ParametersExpand Collapse

after: optional string

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

before: optional string

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

identifier_key: optional string

identity_type: optional IdentityType

Enum to represent the type of the identity.

Accepts one of the following:

"org"

"user"

"other"

limit: optional number

Maximum number of identities to return

name: optional string

order: optional "asc" or "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: optional "created_at"

Field to sort by

Accepts one of the following:

"created_at"

project_id: optional string

ReturnsExpand Collapse

id: string

The human-friendly ID of the Identity

Deprecatedagent_ids: array of string

The IDs of the agents associated with the identity.

Deprecatedblock_ids: array of 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: optional string

The project id of the identity, if applicable.

properties: optional array of IdentityProperty { key, type, value }

List of properties associated with the identity

key: string

The key of the property

type: "string" or "number" or "boolean" or "json"

The type of the property

Accepts one of the following:

"string"

"number"

"boolean"

"json"

value: string or number or boolean or map[unknown]

The value of the property

Accepts one of the following:

UnionMember0 = string

UnionMember1 = number

UnionMember2 = boolean

UnionMember3 = map[unknown]

List Identities

curl https://api.letta.com/v1/identities/ \
    -H "Authorization: Bearer $LETTA_API_KEY"

[
  {
    "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"
      }
    ]
  }
]