Listar formulários
GET/api/forms
- Auth
- Requires a token
- Who can call it:
- owner
- API key:
- No API key accepted
- X-CommunityId
X-CommunityIdSend the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.
Qualquer papel. Quem gerencia (quem criou, a equipe, os responsáveis) recebe os formulários que gerencia em qualquer estado, com `submissionsByStatus`; os demais, só os abertos a membros, nos espaços que abrem (`canManage: false`, sem token nem contagem). `includeDeleted=true` (só o owner) traz os apagados, para chegar aos envios.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
spaceIdoptional | query | string (uuid) | |
statusoptional | query | draft | open | closed | |
includeDeletedoptional | query | boolean | |
pageoptional | query | integer | |
limitoptional | query | integer |
Headers
| Name | Type | Description |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Responses
| Status | Description |
|---|---|
200 | Os formulários. |
401 | Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`). |
403 | Autenticado, mas sem permissão para esta operação. |
422 | Espaço que não é de formulários, ou `status` inválido. |
curl example
curl -X GET "https://api.memberfy.net/api/forms" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"