Buscar usuários

Endpoint: GET https://croncrm.com/api/v2/accounts/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

name, email, access_token, page (opcionais)

Atributo Descrição Obrigatório Tipo

name

Filtro por nome.

Não

String

email

Filtro por email.

Não

String

access_token

Filtro por token da conta.

Não

String

page

Página da listagem.

Não

Number

GET /api/v2/accounts/find?name=Agente&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.

Number

pages

Total de páginas.

Number

limit

Limite por página.

Number

count

Quantidade total de registros retornados.

Number

accounts

Lista de contas encontradas.

name: (String) Nome completo.

created: (String) Data de criação da conta.

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

email: (String) Email da conta.

phone: (String) Telefone da conta.

role: (String) Função/perfil da conta.

online: (Boolean) Indica se a conta está online.

observations: (String) Observações da conta.

access_token: (String) Token da conta.

Array|null

{
  "success": true,
  "msg": "Consulta realizada com sucesso.",
  "page": 1,
  "pages": 1,
  "limit": 20,
  "count": 1,
  "accounts": [
    {
      "name": "Agente 1",
      "created": "01/01/2026 10:00:00",
      "modified": "01/01/2026 10:00:00",
      "email": "[email protected]",
      "phone": "559999999999",
      "role": "admin",
      "online": false,
      "observations": "",
      "access_token": "ACCOUNT_TOKEN"
    }
  ]
}
<?php
$apiKey = 'SEU_API_KEY';
$url = 'https://croncrm.com/api/v2/accounts/find';

$query = http_build_query([
    'name' => 'Agente',
    'page' => 1,
]);

$ch = curl_init($url . '?' . $query);
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/accounts/find' \
  -H 'apiKey: SEU_API_KEY' \
  --data-urlencode 'name=Agente' \
  --data-urlencode 'page=1'