Skip to main content
GET
/
departments
Listar departamentos/unidades administrativas
curl --request GET \
  --url https://services.pref.rio/rmi/v1/departments \
  --header 'Authorization: Bearer <token>'
{
  "departments": [
    {
      "cd_ua": "<string>",
      "cd_ua_pai": "<string>",
      "id": "<string>",
      "msg": "<string>",
      "nivel": 123,
      "nome_ua": "<string>",
      "ordem_absoluta": "<string>",
      "ordem_relativa": "<string>",
      "ordem_ua_basica": "<string>",
      "sigla_ua": "<string>",
      "updated_at": "<string>"
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "total_pages": 123
  },
  "total_count": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

parent_id
string

Código da UA pai para filtrar departamentos filhos

min_level
integer

Nível mínimo do departamento

Required range: x >= 1
max_level
integer

Nível máximo do departamento

Required range: x >= 1
exact_level
integer

Nível exato do departamento (sobrescreve min/max)

Required range: x >= 1
sigla_ua
string

Sigla da UA para filtro exato

Texto para busca textual em nome_ua

page
integer

Número da página (padrão: 1)

Required range: x >= 1
per_page
integer

Itens por página (padrão: 10, máximo: 100)

Required range: 1 <= x <= 100

Response

Lista paginada de departamentos obtida com sucesso

departments
object[]
pagination
object
total_count
integer