Endpoint
GET /v1/companies
read:companies
Parâmetros de query
| Parâmetro | Tipo | Descrição |
|---|---|---|
limit | integer | Itens por página. Padrão: 25. Máximo: 100 |
cursor | string | Token de paginação |
search | string | Busca por nome, email ou telefone |
tag | string | Filtra por tag exata |
sector | string | Filtra por setor (busca parcial, case-insensitive) |
size | string | Filtra por tamanho: 1-10, 11-50, 51-200, 201-500, 500+ |
assigned_to | string | ID do membro responsável |
document | string | CNPJ, com ou sem máscara |
external_id | string | Identificador da empresa no seu sistema |
Exemplo de requisição
curl "https://api.socialsell.ai/v1/companies?sector=tecnologia&size=51-200" \
-H "Authorization: Bearer sk_live_..."
Exemplo de resposta
{
"data": [
{
"id": "664b1c2d3e4f5a6789012346",
"name": "Empresa ABC Ltda",
"email": "contato@empresaabc.com.br",
"phone": "+5511333344445",
"website": "https://empresaabc.com.br",
"document": "12345678000195",
"external_id": null,
"sector": "Tecnologia",
"size": "51-200",
"city": "São Paulo",
"state": "SP",
"assigned_to": {
"id": "664a1b2c3d4e5f6789012345",
"name": "Maria Santos"
},
"tags": ["parceiro", "tech"],
"custom_fields": {},
"contacts_count": 8,
"deals_count": 3,
"total_deals_value": 45000,
"created_at": "2026-01-10T09:00:00.000Z",
"updated_at": "2026-05-20T11:30:00.000Z"
}
],
"meta": {
"total": 87,
"has_more": false,
"next_cursor": null,
"request_id": "req_a1b2c3d4e5f6a7b8"
}
}
Objeto empresa
| Campo | Tipo | Descrição |
|---|---|---|
id | string | ID único da empresa |
name | string | Nome da empresa |
email | string|null | |
phone | string|null | Telefone |
website | string|null | Site |
document | string|null | CNPJ, só os 14 dígitos |
external_id | string|null | Identificador da empresa no seu sistema, único por organização |
sector | string|null | Setor de atuação |
size | string|null | Tamanho: 1-10, 11-50, 51-200, 201-500, 500+ |
city | string|null | Cidade |
state | string|null | Estado |
assigned_to | object|null | Responsável {id, name} |
tags | string[] | Tags |
custom_fields | object | Campos personalizados |
contacts_count | integer | Contatos vinculados à empresa |
deals_count | integer | Negócios vinculados à empresa |
total_deals_value | number | Soma do valor dos negócios vinculados |
created_at | string | Timestamp de criação |
updated_at | string | Timestamp de atualização |
Erros
Além dos erros comuns a toda a API — autenticação, escopo e limite de requisições — esta rota pode responder:| Código | Status | Descrição |
|---|---|---|
INTERNAL_ERROR | 500 | Falha interna ao processar a requisição |