Skip to main content

Endpoint

GET /v1/companies
Escopo necessário: read:companies

Parâmetros de query

ParâmetroTipoDescrição
limitintegerItens por página. Padrão: 25. Máximo: 100
cursorstringToken de paginação
searchstringBusca por nome, email ou telefone
tagstringFiltra por tag exata
sectorstringFiltra por setor (busca parcial, case-insensitive)
sizestringFiltra por tamanho: 1-10, 11-50, 51-200, 201-500, 500+
assigned_tostringID do membro responsável

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",
      "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_01jx8kz3m4n5p6q7r8s9t0u1v"
  }
}

Objeto empresa

CampoTipoDescrição
idstringID único da empresa
namestringNome da empresa
emailstring|nullEmail
phonestring|nullTelefone
websitestring|nullSite
sectorstring|nullSetor de atuação
sizestring|nullTamanho: 1-10, 11-50, 51-200, 201-500, 500+
citystring|nullCidade
statestring|nullEstado
assigned_toobject|nullResponsável {id, name}
tagsstring[]Tags
custom_fieldsobjectCampos personalizados
contacts_countintegerQuantidade de contatos vinculados
deals_countintegerQuantidade de negócios vinculados
total_deals_valuenumberValor total dos negócios
created_atstringTimestamp de criação
updated_atstringTimestamp de atualização