Login Cadastre-se

Procurar canais

Endpoint: GET https://croncrm.com/api/v2/instances/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, access_token, page (opcionais)

Atributo Descrição Obrigatório Tipo

name

Filtro por nome do canal.

Não

String

access_token

Filtro por token do canal.

Não

String

page

Página da listagem.

Não

Number

 
GET /api/v2/instances/find?name=Canal&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

instances

Lista de canais encontradas.

name: (String) Nome do canal.

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

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

type: (Object) Tipo do canal (code/name).

phone_wid: (String|null) Identificador do telefone (quando aplicável).

instagram_username: (String|null) Usuário do Instagram (quando aplicável).

need_delete: (Boolean) Indica se está marcada para remoção.

count_chats_month: (Number) Quantidade de chats no mês.

count_chats: (Number) Quantidade total de chats.

storage_used: (Object) Uso de armazenamento (total/formated).

api_enable: (Boolean) Indica se a API está habilitada.

have_external_chatbot: (Boolean) Indica se possui chatbot externo.

in_log: (Boolean) Indica se está em log.

improved_synchronization: (Boolean) Indica se a sincronização aprimorada está habilitada.

webhooks: (Object) URLs de webhooks (message, incomingCall, stateChanged, qrcode, liveLocation, participantsChanged, addedToGroup).

api_key: (String) API Key do canal.

accounts: (Object|Array) Dados do usuário vinculado (quando houver).

access_token: (String) Token do canal.

Array|null

 
{
  "success": true,
    "msg": "Consulta realizada com sucesso.",
  "page": 1,
  "pages": 1,
  "limit": 20,
  "count": 1,
  "instances": [
    {
      "name": "Canal 1",
            "created": "01/01/2026 10:00:00",
            "modified": "01/01/2026 10:00:00",
            "type": {
                "code": 1,
                "name": "Desconhecido"
            },
            "phone_wid": null,
            "instagram_username": null,
            "need_delete": false,
            "count_chats_month": 0,
            "count_chats": 0,
            "storage_used": {
                "total": 0,
                "formated": "0 B"
            },
            "api_enable": true,
            "have_external_chatbot": true,
            "in_log": false,
            "improved_synchronization": true,
            "webhooks": {
                "message": "https://meuservidor.com/webhooks/message",
                "incomingCall": "",
                "stateChanged": "",
                "qrcode": "",
                "liveLocation": "",
                "participantsChanged": "",
                "addedToGroup": ""
            },
      "api_key": "API_KEY",
            "accounts": [],
      "access_token": "INSTANCE_TOKEN"
    }
  ]
}
 
<?php
$apiKey = 'SEU_API_KEY';
$url = 'https://croncrm.com/api/v2/instances/find';

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