List Contacts

List the contacts in one workspace with a substring search across name, e-mail, and phone. Note this list pages by limit rather than perPage — an inconsistency preserved from the original release. Every operation is scoped by the required workspaceId. A workspace-scoped API key that names any other workspace is refused with 403 before any query runs, so a workspace key can only ever reach its own workspace.

GET/api/v1/chat/contacts

Authorization

apiKey
X-API-Key<token>

Your Studio API key, personal or workspace-scoped. Generate one under Settings, then API Keys. Operations that reject workspace keys say so in their own description.

In: header

Query Parameters

workspaceId*string

Workspace whose contacts are listed.

Length1 <= length
search?string

Case-insensitive substring matched against the name, e-mail, and phone at once.

Length1 <= length <= 200
page?integer

1-based page number. Defaults to 1.

Default1
Range1 <= value <= 9007199254740991
limit?integer

Items per page, between 1 and 100. Defaults to 25.

Default25
Range1 <= value <= 100
sortBy?string

Column to order by. Defaults to createdAt.

Default"createdAt"
Value in"name" | "email" | "lastActivityAt" | "createdAt"
sortOrder?string

Order direction. Defaults to desc.

Default"desc"
Value in"asc" | "desc"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://agent-studio.seeyu.ai/api/v1/chat/contacts?workspaceId=string" \  -H "X-API-Key: YOUR_API_KEY"
{
  "contacts": [
    {
      "id": "cnt_01J8F2K3N5P9",
      "name": "Ana Ribeiro",
      "firstName": "Ana",
      "lastName": "Ribeiro",
      "email": "ana@example.com",
      "phone": "+5511987654321",
      "avatarUrl": null,
      "companyName": "Ribeiro Ltda",
      "lastActivityAt": "2026-08-28T14:22:05.000Z",
      "createdAt": "2026-07-24T11:02:19.000Z",
      "conversationCount": 3
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 25,
    "total": 1,
    "totalPages": 1
  }
}
{
  "error": "Invalid input: expected string, received undefined",
  "details": [
    {
      "code": "invalid_type",
      "expected": "string",
      "path": [
        "phone"
      ],
      "message": "Invalid input: expected string, received undefined"
    }
  ]
}
{
  "error": "Unauthorized"
}
{
  "error": "API key is not authorized for this workspace"
}
{
  "error": "Rate limit exceeded",
  "message": "API rate limit exceeded. Please retry after 2026-09-13T12:00:00.000Z",
  "retryAfter": 1789286400000
}
{
  "error": "Internal server error",
  "requestId": "req_01J9Z2K3M4N5P6Q7R8S9T0"
}
GETGet ContactGETList Team Members