Assuntos

Visualização Markdown

Carregando...

Markdown do endpoint

—

Selecione um endpoint para visualizar o markdown.

Grupo

Listar Assuntos

GET /api/v2/assuntos

Requer autenticaçãoGrátis

Retorna uma lista paginada de assuntos disponíveis.

Visão geral

Este endpoint exige autenticação.
Método HTTP: GET.

Query Parameters

nome não informado Opcional

Ex:

Nome do assunto para busca (match parcial).

path não informado Opcional

Ex:

Hierarquia/caminho do assunto (match parcial).

materia boolean Opcional

Ex:

Filtra matérias (assuntos sem pai) quando true e demais assuntos quando false.

limit integer Opcional

Ex:

Quantidade de assuntos por página. Default: 20. Valores permitidos: 20, 50 ou 100 (máximo: 100).

Name	Tipo	Obrigatório	Description	Example
`nome`	`não informado`	Opcional	Nome do assunto para busca (match parcial).	`Homicídio`
`path`	`não informado`	Opcional	Hierarquia/caminho do assunto (match parcial).	`Direito Penal`
`materia`	`boolean`	Opcional	Filtra matérias (assuntos sem pai) quando `true` e demais assuntos quando `false`.	`true`
`limit`	`integer`	Opcional	Quantidade de assuntos por página. Default: 20. Valores permitidos: 20, 50 ou 100 (máximo: 100).	`20`

Exemplos de respostas válidas

Esse é um exemplo de resposta bem-sucedida.

HTTP 200 ?

{
    "items": [
        {
            "codigo_cnj": "14",
            "materia": true,
            "nome": "DIREITO TRIBUTÁRIO",
            "path_completo": "DIREITO TRIBUTÁRIO"
        },
        {
            "codigo_cnj": "3387",
            "materia": false,
            "nome": "Seguida de Morte",
            "path_completo": "DIREITO PENAL | Lesão Corporal | Seguida de Morte"
        }
    ],
    "links": {
        "next": "https://api.escavador.com/api/v2/assuntos?cursor=eyJpZCI6MTgyMSwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ"
    },
    "paginator": {
        "per_page": 20
    }
}

HTTP 401 ?

{
    "error": "Unauthenticated"
}

HTTP 404 ?

{
    "error": "NotFound"
}

# Listar Assuntos

`GET /api/v2/assuntos`

## Descrição

Retorna uma lista paginada de assuntos disponíveis.

## Query Parameters

| Name | Tipo | Obrigatório | Descrição | Exemplo |
| --- | --- | --- | --- | --- |
| `nome` | `string` | Não | Nome do assunto para busca (match parcial). | `Homicídio` |
| `path` | `string` | Não | Hierarquia/caminho do assunto (match parcial). | `Direito Penal` |
| `materia` | `boolean` | Não | Filtra matérias (assuntos sem pai) quando `true` e demais assuntos quando `false`. | `true` |
| `limit` | `integer` | Não | Quantidade de assuntos por página. Default: 20. Valores permitidos: 20, 50 ou 100 (máximo: 100). | `20` |

## Exemplos de respostas válidas

### Esse é um exemplo de resposta bem-sucedida.

HTTP 200

```json
{
    "items": [
        {
            "codigo_cnj": "14",
            "materia": true,
            "nome": "DIREITO TRIBUTÁRIO",
            "path_completo": "DIREITO TRIBUTÁRIO"
        },
        {
            "codigo_cnj": "3387",
            "materia": false,
            "nome": "Seguida de Morte",
            "path_completo": "DIREITO PENAL | Lesão Corporal | Seguida de Morte"
        }
    ],
    "links": {
        "next": "https://api.escavador.com/api/v2/assuntos?cursor=eyJpZCI6MTgyMSwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ"
    },
    "paginator": {
        "per_page": 20
    }
}
```

### Resposta 2

HTTP 401

```json
{
    "error": "Unauthenticated"
}
```

### Resposta 3

HTTP 404

```json
{
    "error": "NotFound"
}
```

GET

https://api.escavador.com/api/v2/assuntos

Exemplo de requisição

curl -X GET "https://api.escavador.com/api/v2/assuntos?nome=Homic%C3%ADdio&path=Direito+Penal&materia=1&limit=20" \
  -H "Authorization: Bearer {{token}}" \
  -H "Accept: application/json"

Exemplo de resposta

{
    "items": [
        {
            "codigo_cnj": "14",
            "materia": true,
            "nome": "DIREITO TRIBUTÁRIO",
            "path_completo": "DIREITO TRIBUTÁRIO"
        },
        {
            "codigo_cnj": "3387",
            "materia": false,
            "nome": "Seguida de Morte",
            "path_completo": "DIREITO PENAL | Lesão Corporal | Seguida de Morte"
        }
    ],
    "links": {
        "next": "https://api.escavador.com/api/v2/assuntos?cursor=eyJpZCI6MTgyMSwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ"
    },
    "paginator": {
        "per_page": 20
    }
}

Exemplo de requisição

fetch("https://api.escavador.com/api/v2/assuntos?nome=Homic%C3%ADdio&path=Direito+Penal&materia=1&limit=20", {
  method: "GET",
  headers:   {
      "Accept": "application/json",
      "Authorization": "Bearer {{token}}"
  }
})
  .then(response => response.json())
  .then(data => console.log(data));

Exemplo de resposta

{
    "items": [
        {
            "codigo_cnj": "14",
            "materia": true,
            "nome": "DIREITO TRIBUTÁRIO",
            "path_completo": "DIREITO TRIBUTÁRIO"
        },
        {
            "codigo_cnj": "3387",
            "materia": false,
            "nome": "Seguida de Morte",
            "path_completo": "DIREITO PENAL | Lesão Corporal | Seguida de Morte"
        }
    ],
    "links": {
        "next": "https://api.escavador.com/api/v2/assuntos?cursor=eyJpZCI6MTgyMSwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ"
    },
    "paginator": {
        "per_page": 20
    }
}

Exemplo de requisição

$client = new \GuzzleHttp\Client();

$response = $client->request("GET", "https://api.escavador.com/api/v2/assuntos", [
    'headers' => [
        'Accept' => 'application/json',
        'Authorization' => 'Bearer {{token}}',
    ],
    'query' => [
        'nome' => 'Homicídio',
        'path' => 'Direito Penal',
        'materia' => true,
        'limit' => 20,
    ],
]);

echo $response->getBody()->getContents();

Exemplo de resposta

{
    "items": [
        {
            "codigo_cnj": "14",
            "materia": true,
            "nome": "DIREITO TRIBUTÁRIO",
            "path_completo": "DIREITO TRIBUTÁRIO"
        },
        {
            "codigo_cnj": "3387",
            "materia": false,
            "nome": "Seguida de Morte",
            "path_completo": "DIREITO PENAL | Lesão Corporal | Seguida de Morte"
        }
    ],
    "links": {
        "next": "https://api.escavador.com/api/v2/assuntos?cursor=eyJpZCI6MTgyMSwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ"
    },
    "paginator": {
        "per_page": 20
    }
}

Exemplo de requisição

import requests

url = "https://api.escavador.com/api/v2/assuntos"
headers = {
    "Accept": "application/json",
    "Authorization": "Bearer {{token}}"
}
params = {
    "nome": "Homicídio",
    "path": "Direito Penal",
    "materia": true,
    "limit": 20
}

response = requests.request(
    "GET",
    url,
    headers=headers,
    params=params,
)

print(response.json())

Exemplo de resposta

{
    "items": [
        {
            "codigo_cnj": "14",
            "materia": true,
            "nome": "DIREITO TRIBUTÁRIO",
            "path_completo": "DIREITO TRIBUTÁRIO"
        },
        {
            "codigo_cnj": "3387",
            "materia": false,
            "nome": "Seguida de Morte",
            "path_completo": "DIREITO PENAL | Lesão Corporal | Seguida de Morte"
        }
    ],
    "links": {
        "next": "https://api.escavador.com/api/v2/assuntos?cursor=eyJpZCI6MTgyMSwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ"
    },
    "paginator": {
        "per_page": 20
    }
}

Exemplos

/api/v2/assuntos

GET

https://api.escavador.com/api/v2/assuntos

Exemplo de requisição

curl -X GET "https://api.escavador.com/api/v2/assuntos?nome=Homic%C3%ADdio&path=Direito+Penal&materia=1&limit=20" \
  -H "Authorization: Bearer {{token}}" \
  -H "Accept: application/json"

Exemplo de resposta

{
    "items": [
        {
            "codigo_cnj": "14",
            "materia": true,
            "nome": "DIREITO TRIBUTÁRIO",
            "path_completo": "DIREITO TRIBUTÁRIO"
        },
        {
            "codigo_cnj": "3387",
            "materia": false,
            "nome": "Seguida de Morte",
            "path_completo": "DIREITO PENAL | Lesão Corporal | Seguida de Morte"
        }
    ],
    "links": {
        "next": "https://api.escavador.com/api/v2/assuntos?cursor=eyJpZCI6MTgyMSwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ"
    },
    "paginator": {
        "per_page": 20
    }
}

Exemplo de requisição

fetch("https://api.escavador.com/api/v2/assuntos?nome=Homic%C3%ADdio&path=Direito+Penal&materia=1&limit=20", {
  method: "GET",
  headers:   {
      "Accept": "application/json",
      "Authorization": "Bearer {{token}}"
  }
})
  .then(response => response.json())
  .then(data => console.log(data));

Exemplo de resposta

{
    "items": [
        {
            "codigo_cnj": "14",
            "materia": true,
            "nome": "DIREITO TRIBUTÁRIO",
            "path_completo": "DIREITO TRIBUTÁRIO"
        },
        {
            "codigo_cnj": "3387",
            "materia": false,
            "nome": "Seguida de Morte",
            "path_completo": "DIREITO PENAL | Lesão Corporal | Seguida de Morte"
        }
    ],
    "links": {
        "next": "https://api.escavador.com/api/v2/assuntos?cursor=eyJpZCI6MTgyMSwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ"
    },
    "paginator": {
        "per_page": 20
    }
}

Exemplo de requisição

$client = new \GuzzleHttp\Client();

$response = $client->request("GET", "https://api.escavador.com/api/v2/assuntos", [
    'headers' => [
        'Accept' => 'application/json',
        'Authorization' => 'Bearer {{token}}',
    ],
    'query' => [
        'nome' => 'Homicídio',
        'path' => 'Direito Penal',
        'materia' => true,
        'limit' => 20,
    ],
]);

echo $response->getBody()->getContents();

Exemplo de resposta

{
    "items": [
        {
            "codigo_cnj": "14",
            "materia": true,
            "nome": "DIREITO TRIBUTÁRIO",
            "path_completo": "DIREITO TRIBUTÁRIO"
        },
        {
            "codigo_cnj": "3387",
            "materia": false,
            "nome": "Seguida de Morte",
            "path_completo": "DIREITO PENAL | Lesão Corporal | Seguida de Morte"
        }
    ],
    "links": {
        "next": "https://api.escavador.com/api/v2/assuntos?cursor=eyJpZCI6MTgyMSwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ"
    },
    "paginator": {
        "per_page": 20
    }
}

Exemplo de requisição

import requests

url = "https://api.escavador.com/api/v2/assuntos"
headers = {
    "Accept": "application/json",
    "Authorization": "Bearer {{token}}"
}
params = {
    "nome": "Homicídio",
    "path": "Direito Penal",
    "materia": true,
    "limit": 20
}

response = requests.request(
    "GET",
    url,
    headers=headers,
    params=params,
)

print(response.json())

Exemplo de resposta

{
    "items": [
        {
            "codigo_cnj": "14",
            "materia": true,
            "nome": "DIREITO TRIBUTÁRIO",
            "path_completo": "DIREITO TRIBUTÁRIO"
        },
        {
            "codigo_cnj": "3387",
            "materia": false,
            "nome": "Seguida de Morte",
            "path_completo": "DIREITO PENAL | Lesão Corporal | Seguida de Morte"
        }
    ],
    "links": {
        "next": "https://api.escavador.com/api/v2/assuntos?cursor=eyJpZCI6MTgyMSwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ"
    },
    "paginator": {
        "per_page": 20
    }
}

Assuntos - Escavador Business API - Documentação

Visão geral

Query Parameters

Exemplos de respostas válidas