Login Cadastre-se

Procurar clientes

Endpoint: GET https://croncrm.com/api/v2/leads/find

Header do request
Atributo Descrição Obrigatório Tipo

apiKey

Informe sua API Key gerada na interface do CRONCRM.

Sim

String
Query do request

Todos os campos abaixo são opcionais.

Atributo Descrição Obrigatório Tipo

name

Nome do cliente.

Não

String

email

Email do cliente.

Não

String

cpf_cnpj

CPF/CNPJ do cliente.

Não

String

phone

Telefone do cliente.

Não

String

chat_wid

WID do chat relacionado.

Não

String

date_from

Data inicial para filtro.

Não

String

date_end

Data final para filtro.

Não

String

date_start

Data inicial para filtro.

Não

String

access_token

Token do cliente.

Não

String

page

Página da listagem.

Não

Inteiro

 
GET /api/v2/leads/find?name=Jo%C3%A3o&page=1
Response do request

Em caso de sucesso, retorna HTTP 200 com success true. Método incorreto retorna 405; falhas inesperadas retornam 500.

Atributo Descrição Tipo

success

Informa se a operação teve sucesso ou não.

Boolean

msg

Mensagem de retorno.

String

page

Página atual.

Inteiro

pages

Total de páginas.

Inteiro

limit

Quantidade de registros por página.

Inteiro

count

Total de registros encontrados.

Inteiro

leads

Lista de clientes.

full_name: (String) Nome do cliente.

created: (String) Data de criação do cliente.

modified: (String) Data da última alteração do cliente.

cpf: (String) CPF do cliente.

birthdate: (String) Data de nascimento do cliente.

phone: (String) Telefone do cliente.

email: (String) Email do cliente.

phone1: (String) Telefone adicional do cliente.

phone2: (String) Telefone adicional do cliente.

email1: (String) Email adicional do cliente.

email2: (String) Email adicional do cliente.

social_name: (String) Razão social do cliente.

cnpj: (String) CNPJ do cliente.

business_email: (String) Email empresarial do cliente.

observations: (String) Observações do cliente.

cep: (String) CEP do cliente.

address: (String) Endereço do cliente.

number: (String) Número do endereço do cliente.

neighborhood: (String) Bairro do cliente.

completion: (String) Complemento do endereço do cliente.

city_ibge: (String) Código IBGE da cidade vinculada ao cliente.

access_token: (String) Token do cliente.

accounts: (Array) Usuários vinculados ao cliente.

chats: (Array) Conversas vinculadas ao cliente.

Array|null

 
{
  "success": true,
  "msg": "Consulta realizada com sucesso.",
  "page": 1,
  "pages": 1,
  "limit": 20,
  "count": 1,
  "leads": [
    {
      "full_name": "João da Silva",
      "created": "01/01/2026 10:00:00",
      "modified": "01/01/2026 10:00:00",
      "cpf": "",
      "birthdate": "",
      "phone": "5599...",
      "email": "",
      "city_ibge": "",
      "access_token": "LEAD_TOKEN",
      "accounts": [],
      "chats": []
    }
  ]
}
 
<?php
$apiKey = 'SEU_API_KEY';
$baseUrl = 'https://croncrm.com/api/v2/leads/find';

$query = [
    'name' => 'João',
    'page' => 1,
];

$url = $baseUrl . '?' . http_build_query($query);

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'apiKey: ' . $apiKey,
    ],
]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
$error = curl_error($ch);
curl_close($ch);

if ($error) {
    throw new RuntimeException($error);
}

echo "HTTP {$httpCode}\n";
echo $response;
?>
curl -G \
  'https://croncrm.com/api/v2/leads/find' \
  -H 'apiKey: SEU_API_KEY' \
  --data-urlencode 'name=João' \
  --data-urlencode 'page=1'