Pular para o conteúdo

Empresas

Base path: /api/v1/companies Scopes: companies:read | companies:write

Empresas (companies) são pessoas jurídicas no seu CRM. Cada empresa pode ter múltiplos contatos vinculados e múltiplos negócios.

Lista empresas

GET /api/v1/companies

Scope: companies:read

ParamTipoDefaultDescrição
pagenumber1Página atual
pageSizenumber50Itens por página (máx 100)
searchstringBusca em nome, CNPJ, website
ownerIdstringFiltra por owner
sortKeystringcreatedAtCampo de ordenação
sortOrderasc | descdescDireção
Terminal window
curl "https://app.indutivacrm.com.br/api/v1/companies?search=acme" \
-H "X-API-Key: crm_live_..."
{
"data": [
{
"id": "ckl4c01...",
"name": "Acme Indústria SA",
"cnpj": "00.000.000/0001-00",
"website": "https://acme.com.br",
"phone": "+551133334444",
"domain": "acme.com.br",
"ownerId": "ckl4z00...",
"industry": "Manufatura",
"createdAt": "2026-05-22T14:30:00.000Z"
}
],
"pagination": { ... }
}

Busca uma empresa

GET /api/v1/companies/:id

Scope: companies:read

Retorna a empresa com todos os campos padrão + customProperties.

Cria uma empresa

POST /api/v1/companies

Scope: companies:write

CampoTipoObrigatórioDescrição
namestringRazão social ou nome fantasia
cnpjstringCNPJ (será normalizado pra só dígitos)
websitestringURL completa (https://…)
domainstringDomínio puro (acme.com.br) — usado pra match automático com contatos
phonestringTelefone
industrystringSetor/indústria
ownerIdstringUser dono
customPropertiesobject{ propertyId: value }
Terminal window
curl -X POST https://app.indutivacrm.com.br/api/v1/companies \
-H "X-API-Key: crm_live_..." \
-H "Content-Type: application/json" \
-d '{
"name": "Acme Indústria SA",
"cnpj": "00000000000100",
"domain": "acme.com.br",
"industry": "Manufatura"
}'

Atualiza uma empresa

PATCH /api/v1/companies/:id

Scope: companies:write

Atualização parcial. Mesmos campos do POST.

Deleta uma empresa

DELETE /api/v1/companies/:id

Scope: companies:write

Soft-delete. Contatos e deals vinculados ficam — só perdem a referência à empresa.

Resposta 204 No Content.

Erros específicos

StatuserrorCenário
409duplicate_cnpjPOST com CNPJ já existente no tenant
409duplicate_domainPOST com domínio já existente
400validation_failedname ausente, CNPJ malformado
404not_foundid não existe