Obter Contato

Obter um contato com a empresa vinculada e os dois conjuntos de atributos. O conversationCount do endpoint de listagem não se repete aqui — ele é um agregado de lista e custaria uma contagem correlacionada em uma leitura de uma única linha. Toda operação é delimitada pelo workspaceId obrigatório. Uma API key com escopo de workspace que nomeie qualquer outro workspace é recusada com 403 antes de qualquer consulta rodar, então uma API key de workspace só consegue alcançar o próprio workspace. Um contato em outro workspace é reportado como 404, nunca como negado.

GET/api/v1/chat/contacts/{contactId}

Authorization

apiKey
X-API-Key<token>

Sua API key do Studio, pessoal ou com escopo de workspace. Gere uma em Settings e depois API Keys. As operações que rejeitam API keys de workspace dizem isso na própria descrição.

Em: header

Parâmetros de path

contactId*string

Contato a obter.

Tamanho1 <= length

Parâmetros de query

workspaceId*string

Workspace ao qual o contato pertence.

Tamanho1 <= length

Corpo da resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://agent-studio.seeyu.ai/api/v1/chat/contacts/string?workspaceId=string" \  -H "X-API-Key: YOUR_API_KEY"
{
  "contact": {
    "id": "cnt_01J8F2K3N5P9",
    "name": "Ana Ribeiro",
    "firstName": "Ana",
    "lastName": "Ribeiro",
    "email": "ana@example.com",
    "phone": "+5511987654321",
    "avatarUrl": null,
    "gender": null,
    "description": null,
    "identifier": "crm-4821",
    "blocked": false,
    "contactType": 2,
    "company": {
      "id": "cmp_01J8F2K3N5PB",
      "name": "Ribeiro Ltda",
      "domain": "ribeiro.example"
    },
    "customAttributes": {
      "plan": "pro"
    },
    "additionalAttributes": {
      "source": "whatsapp"
    },
    "lastActivityAt": "2026-08-28T14:22:05.000Z",
    "createdAt": "2026-07-24T11:02:19.000Z"
  }
}
{
  "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": "Conversation not found"
}
{
  "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"
}
POSTCriar ContatoGETListar Contatos