Login Cadastre-se

Buscar contatos

Endpoint: GET https://croncrm.com/api/v2/contacts-croncrm/find

Busque contatos cadastrados na plataforma.

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

apiKey

Informe sua API Key gerada na interface do CRONCRM.

Sim

String
Query do request

IMPORTANTE: Deixe vazio os campos abaixo para retornar todos os contatos disponíveis.

Atributo Descrição Obrigatório Tipo

access_token

Informe o access_token do contato para buscar um registro específico.

Não

String

contact

Informe o número (com DDI/DDD) ou nome do contato.

Não

String

list

Informe o número, nome da lista ou access_token da lista.

Não

String

page

Página da listagem.

Não

Inteiro

 
{
  "access_token": "CONTACT_TOKEN",
  "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 da listagem.

Inteiro

pages

Total de páginas disponíveis.

Inteiro

limit

Quantidade de registros por página.

Inteiro

count

Total de registros encontrados.

Inteiro

contacts

Array com os registros encontrados.

Confira aqui o detalhamento dos atributos de um contato.

Array

 
{
  "success": true,
  "msg": "Consulta realizada com sucesso.",
    "page": 1,
    "pages": 1,
    "limit": 10,
    "count": 1,
  "contacts": [
    {
      "name": "",
      "created": {
        "date": "2024-12-02 02:08:06",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      },
      "modified": {
        "date": "2024-12-02 02:08:06",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      },
      "phone": "+55 (21) xxxxx-xxxx",
      "phone_wid": "[email protected]",
      "variable01": "",
      "variable02": "",
      "variable03": "",
      "variable04": "",
      "variable05": "",
      "variable06": "",
      "description": "",
      "have_whatsapp": 4,
      "opt_out": false,
      "opt_out_datetime": "",
      "access_token": "CONTACT_TOKEN",
      "list": {
        "name": "Lista de contatos para teste",
        "access_token": "LIST_TOKEN"
      }
    }
  ]
}
 
<?php
$apiKey = 'SEU_API_KEY';
$baseUrl = 'https://croncrm.com/api/v2/contacts-croncrm/find';

$query = [
    'contact' => 'Fulano',
    '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/contacts-croncrm/find' \
  -H 'apiKey: SEU_API_KEY' \
  --data-urlencode 'contact=Fulano' \
  --data-urlencode 'page=1'