Login Cadastre-se

Buscar lista de contatos

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

Busque listas de contatos cadastradas anteriormente.

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 todas as listas disponíveis.

Atributo Descrição Obrigatório Tipo

name

Informe o nome da lista.

Não

String

access_token

Informe o token da lista para retornar dados de uma lista específica.

Não

String

page

Página da listagem.

Não

Inteiro

 
{
  "name": "Clientes",
  "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

lists

Listas encontradas.

name: (String) Nome da lista.

created: (DateTime) Data e hora que foi criada.

description: (String) Descrição da lista.

access_token: (String) Token gerado pelo CRONCRM para a lista.

contacts: (Array) Contatos vinculados à lista.

Array

 
{
  "success": true,
  "msg": "Consulta realizada com sucesso.",
      "page": 1,
      "pages": 1,
      "limit": 10,
      "count": 1,
      "lists": [
        {
          "name": "testando criar lista de contatos pela API",
          "created": {
            "date": "2023-12-29 06:09:30",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "description": "descrição da lista",
          "access_token": "LIST_TOKEN",
          "contacts": []
        }
      ]
}
 
<?php
$apiKey = 'SEU_API_KEY';
$baseUrl = 'https://croncrm.com/api/v2/lists/find';

$query = [
    'name' => 'Clientes',
    '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/lists/find' \
  -H 'apiKey: SEU_API_KEY' \
  --data-urlencode 'name=Clientes' \
  --data-urlencode 'page=1'