Skip to content

Listar formulários

GET
/forms

Retorna uma lista de formulários com paginação e filtros

Autorizações

Bearer

Generate a token

TipoHTTP (bearer)

Parâmetros

Parâmetros de Cabeçalho

Community-id*

Identificador da comunidade

Tipostring
Obrigatório
Exemplo"test"

Parâmetros de Consulta

q

Busca por nome do formulário (regex)

Tipostring
active

Filtrar por formulários ativos

Tipoboolean
Padrãotrue
sort

Ordenação dos resultados (ex: -createdAt, name)

Tipostring
Padrão"-createdAt"
limit

Quantidade de resultados por página

Tipointeger
Padrão10
Máximo100
page

Número da página (começa em 0)

Tipointeger
Padrão0

Respostas

Lista de formulários encontrada com sucesso

application/json
JSON
{
"total": 5,
"hits": [
{
"active": true,
"name": "Nome do aluno",
"fields": [
{
"kind": "text",
"name": "fullName",
"caption": "Nome completo",
"required": true,
"allowManuallyInput": true
}
]
}
]
}

Exemplos

cURL
JavaScript
PHP
Python