---
title: "Listar parâmetros disponíveis para filtragem de um modelo"
method: GET
path: "/api/management/system/params/{model_name}"
tags: ["system", "params"]
---

# Listar parâmetros disponíveis para filtragem de um modelo

`GET /api/management/system/params/{model_name}`

Listar parâmetros disponíveis para filtragem de um modelo específico. Use esse endpoint para saber quais parâmetros disponibilizamos para cada objeto.

Leia [aqui a documentação sobre parâmetros disponíveis](https://docs.olie.ai/api-reference/general/advanced-search#descobrindo-campos-dispon%C3%ADveis). Os parâmetros aqui listados são disponíveis apenas nas [buscas avançadas](https://docs.olie.ai/api-reference/general/advanced-search).

## Response `200`

Sucesso: projeto

- object
  - `response` true, required — Indicador de sucesso da requisição
  - `params` object, required — Parâmetros disponíveis para filtros e ordenação do modelo
    - `filters` object[], required — Lista de filtros disponíveis para o modelo
      - `name` string, required — Nome do campo que pode ser filtrado
      - `input_type` 'text' | 'number' | 'datetime-local' | 'date' | 'time' | 'email' | 'tel' | 'url', required — Tipo de input esperado para o filtro
      - `operators` string[], required — Operadores relacionais permitidos para este filtro
      - `options` object[], required — Opções fixas disponíveis para o filtro (usado em campos enum/select)
        - `label` union, required — Rótulo da opção exibido ao usuário
          - string
          - number
        - `value` union, required — Valor da opção usado na query
          - string
          - number
          - boolean
      - `arguments` object[], required — Argumentos adicionais necessários para este filtro funcionar
        - `id` string, required — Identificador único do argumento
        - `label` string, required — Rótulo descritivo do argumento
        - `required` boolean, required — Indica se o argumento é obrigatório
        - `modelClass` string, required — Classe do modelo associado ao argumento
        - `hydrate` object, required — Configuração para popular/hidratar dados do argumento dinamicamente
          - `route` string, required — Rota da API para buscar as opções disponíveis
          - `options` string, required — Chave do objeto de resposta que contém as opções
          - `key` string, required — Campo usado como valor/identificador da opção
          - `label` string, required — Campo usado como rótulo da opção
          - `children_key` string, required — Chave para acessar opções filhas/aninhadas (opcional)
          - `children_label` string, required — Campo usado como rótulo das opções filhas (opcional)
      - `hydrate` object, required — Configuração para popular/hidratar dados do filtro dinamicamente (null se não aplicável)
        - `route` string, required — Rota da API para buscar as opções disponíveis
        - `options` string, required — Chave do objeto de resposta que contém as opções
        - `key` string, required — Campo usado como valor/identificador da opção
        - `label` string, required — Campo usado como rótulo da opção
        - `children_key` string, required — Chave para acessar opções filhas/aninhadas (opcional)
        - `children_label` string, required — Campo usado como rótulo das opções filhas (opcional)
    - `sorting` object[], required — Lista de campos disponíveis para ordenação
      - `name` string, required — Nome do campo que pode ser usado para ordenação
      - `arguments` object[], required — Argumentos adicionais para a ordenação (geralmente vazio)

---

[API](https://skmtc.net/olie-ai/apis/olie-api.md) · [All operations](https://skmtc.net/olie-ai/apis/olie-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/olie-ai/olie-api/revisions/063de6e2e93c/schema)