Login Cadastre-se

Buscar etiqueta

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

Busque etiquetas criadas.

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

apiKey

Informe sua API Key gerada na interface do CRONCRM.

Sim

String

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

access_token

Token da etiqueta que deseja buscar.

Não

String

name

Nome da etiqueta que deseja buscar.

Não

String

page

Página da listagem.

Não

Inteiro 

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

Limite de registros por página.

Inteiro

count

Total de registros encontrados.

Inteiro

tags

Lista de etiquetas encontradas.

name: (String) Nome da etiqueta.

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

modified: (DateTime) Data e hora em que foi alterada.

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

color: (String) Cor da etiqueta.

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

chats: (Inteiro) Total de conversas vinculadas à etiqueta.

Array 

{
  "success": true,
  "msg": "Consulta realizada com sucesso.",
    "page": 1,
    "pages": 1,
    "limit": 10,
    "count": 1,
  "tags": [
    {
      "name": "etiqueta criada pela api 3",
      "created": {
        "date": "2022-11-13 09:21:16",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      },
      "modified": {
        "date": "2022-11-13 09:21:16",
        "timezone_type": 3,
        "timezone": "America/Sao_Paulo"
      },
      "description": "descrição da api",
      "color": "#800000",
            "access_token": "TAG_TOKEN",
            "chats": 0
    }
  ]
}
 
<?php
$apiKey = 'SEU_API_KEY';
$baseUrl = 'https://croncrm.com/api/v2/tags/find';

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