Lista de Requisições

Este endpoint permite listar todas as consultas realizadas pelo usuário autenticado.

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

Requisição

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

Parâmetros

Atenção

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

Nome	Tipo	Obrigatório	Descrição
source	string	false	Tipo da requisição. Ex: courts
platform	string	false	Plataforma utilizada. Ex: esaj
search	string	false	Tribunal consultado. Ex: tjba
page	integer	false	Número da página para paginação. Ex: 1
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)
pending	boolean	false	Filtrar requisições com status pending
warning	boolean	false	Filtrar requisições com status warning
success	boolean	false	Filtrar requisições com status success
error	boolean	false	Filtrar requisições com status error

Exemplos de Requisição

cURL

curl -X GET "https://api.consulta.codilo.com.br/v1/request?source=courts&platform=esaj&search=tjba" \
  -H "Authorization: Bearer SEU_ACCESS_TOKEN"

Python

import requests

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

params = {
    "source": "courts",
    "platform": "esaj",
    "search": "tjba"
}

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

print(response.json())

PHP

<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://api.consulta.codilo.com.br/v1/request?source=courts&platform=esaj&search=tjba');
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/request?source=courts&platform=esaj&search=tjba", {
  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": 1,
    "result": [
      {
        "id": "e8361bc1-903e-4929-b96e-828d12ccc9e8",
        "respondedAt": "2022-03-08T00:23:19.726Z",
        "createdAt": "2022-03-08T00:23:07.485Z",
        "platform": "esaj",
        "status": "success",
        "source": "courts",
        "search": "tjba",
        "query": "principal",
        "param": {
          "key": "cnj",
          "value": "0500275-63.2017.8.05.0103"
        }
      }
    ]
  }
}

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