Lista de Consultas Automáticas

Este endpoint retorna a lista de consultas automáticas criadas pelo usuário autenticado.

Os registros são ordenados por data de criação (mais recentes primeiro).
Por padrão, a resposta retorna as 25 consultas mais recentes, podendo ser ajustada por meio dos parâmetros de paginação.

Requisição

GET https://api.consulta.codilo.com.br/v1/autorequest

Parâmetros

Atenção

Os parâmetros abaixo devem ser enviados como query string.

Nome	Tipo	Obrigatório	Descrição
key	string	false	Tipo da consulta. Valor suportado: cnj
value	string	false	Número do processo no formato CNJ (NNNNNNN-DD.AAAA.J.TR.OOOO)
page	integer	false	Número da página para paginação
limit	integer	false	Quantidade de registros por página. Padrão: 25
start	string	false	Data inicial do filtro (formato YYYY-MM-DD)
end	string	false	Data final do filtro (formato YYYY-MM-DD)

Exemplos de Requisição

cURL

curl -X GET "https://api.consulta.codilo.com.br/v1/autorequest?key=cnj&value=0804495-71.2018.8.10.0001" \
  -H "Authorization: Bearer SEU_ACCESS_TOKEN"

Python

import requests

headers = {
    "Authorization": "Bearer SEU_ACCESS_TOKEN"
}

params = {
    "key": "cnj",
    "value": "0804495-71.2018.8.10.0001"
}

response = requests.get(
    "https://api.consulta.codilo.com.br/v1/autorequest",
    headers=headers,
    params=params
)

print(response.json())

PHP

<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://api.consulta.codilo.com.br/v1/autorequest?key=cnj&value=0804495-71.2018.8.10.0001');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer SEU_ACCESS_TOKEN",
]);

$response = curl_exec($ch);

curl_close($ch);

echo $response;

Node.js

fetch("https://api.consulta.codilo.com.br/v1/autorequest?key=cnj&value=0804495-71.2018.8.10.0001", {
  method: "GET",
  headers: {
    Authorization: "Bearer SEU_ACCESS_TOKEN",
  },
})
  .then(response => response.json())
  .then(data => console.log(data));

Exemplo de Resposta (200 - OK)

Sucesso

{
  "success": true,
  "data": {
    "total": 2,
    "result": [
      {
        "id": "c5c42bbe-7fa8-44d7-9d78-a8c89e821dd9",
        "key": "cnj",
        "value": "0804495-71.2018.8.10.0001",
        "createdAt": "2022-03-08T01:06:42.664Z",
        "requests": [
          { "requestId": "7e11cef3-53da-4deb-81bb-2e07244107de" },
          { "requestId": "471fd997-fa85-479e-a3a8-97d8391537bf" },
          { "requestId": "222f496a-0444-42d3-b9be-78f4927532ac" },
          { "requestId": "f2a9a200-c742-43e1-820c-a008e37ddce3" },
          { "requestId": "d5d6615d-3327-4f73-801f-c94e456cf281" }
        ]
      }
    ]
  }
}

O campo requests contém a lista de requisições individuais geradas automaticamente a partir da consulta automática.

Status Codes

Status	Significado	Descrição
200	OK	Lista retornada com sucesso
401	Unauthorized	Token inválido, expirado ou não informado
429	Too Many Requests	Limite de requisições excedido