Skip to main content
GET
/
me
/
agents
cURL
curl --request GET \
  --url https://api.useanima.sh/v1/me/agents \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "orgId": "<string>",
      "name": "<string>",
      "slug": "<string>",
      "apiKeyPrefix": "<string>",
      "keyRotatedAt": "2023-11-07T05:31:56Z",
      "metadata": {},
      "emailIdentities": [
        {
          "id": "<string>",
          "email": "jsmith@example.com",
          "domain": "<string>",
          "localPart": "<string>",
          "isPrimary": true,
          "verified": true,
          "createdAt": "2023-11-07T05:31:56Z"
        }
      ],
      "phoneIdentities": [
        {
          "id": "<string>",
          "phoneNumber": "<string>",
          "provider": "<unknown>",
          "providerId": "<string>",
          "capabilities": {
            "sms": false,
            "mms": false,
            "voice": false
          },
          "isPrimary": true,
          "createdAt": "2023-11-07T05:31:56Z"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "readiness": {
        "canSendEmail": true,
        "canReceiveEmail": true,
        "canSendSms": true,
        "canPlaceVoiceCall": true,
        "blockers": [
          {
            "field": "<string>",
            "hint": "<string>",
            "remediationUrl": "<string>"
          }
        ]
      }
    }
  ],
  "pagination": {
    "nextCursor": "<string>",
    "hasMore": true
  }
}

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Query Parameters

cursor
string

Opaque cursor from a previous response to fetch the next page

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
limit
integer
default:20

Maximum number of items to return per page (1–100, default 20)

Required range: 1 <= x <= 100
status
enum<string>

Filter agents by lifecycle status

Available options:
ACTIVE,
SUSPENDED,
DELETED
query
string

Free-text search by name or slug

Required string length: 1 - 120

Response

200 - application/json

OK

Paginated cross-org list of agents

items
object[]
required

Agents from every org the authenticated user belongs to

pagination
object
required

Pagination metadata returned with list responses