GET api/v1/crm/empresas

CRM: lista empresas (contas)

Limite: 120 requisições por minuto

Descrição

Lista as empresas (contas) do CRM da loja autenticada, com busca por nome/CNPJ/site, filtro por setor e paginação. O retorno é sempre restrito à loja do token.

Obs.: Utilizar tokenAPI (Authorization: Bearer).

Limite de requisições: 120 requisições por minuto.

Códigos de erro:

Código Descrição
400Requisição inválida.
401Não autorizado — Token ausente, inválido, inativo ou sem permissão.
429Limite de requisições ultrapassada.

Parâmetros de Entrada

Campo Descrição Tipo Obrigatório
buscaTexto livre — filtra por nome, CNPJ/documento ou site.stringnão
setorFiltra pelo setor da empresa.stringnão
paginaPágina (base 0). Padrão 0.intnão
porPaginaItens por página (1 a 200). Padrão 50.intnão

Exemplo de uso:
GET api/v1/crm/empresas?busca=exemplo&pagina=0

Parâmetros de Retorno

Campo Descrição Tipo
empresasLista de empresas da página.array
idIdentificador da empresa.string
nomeNome/razão social.string
documentoCNPJ/documento.string
siteSite.string
emailE-mail.string
telefoneTelefone.string
cidadeCidade.string
ufUF.string
setorSetor.string
portePorte.string
totalTotal de empresas que atendem ao filtro.int
paginaPágina atual (base 0).int
porPaginaItens por página aplicados.int

Exemplo de Resposta

JSON 
{
  "empresas": [
    {
      "id": "507f1f77bcf86cd799439abc",
      "nome": "Empresa Exemplo Ltda",
      "documento": "12345678000199",
      "site": "https://empresa.com.br",
      "email": "contato@empresa.com.br",
      "telefone": "1133334444",
      "cidade": "São Paulo",
      "uf": "SP",
      "setor": "Varejo",
      "porte": "Média"
    }
  ],
  "total": 1,
  "pagina": 0,
  "porPagina": 50
}