Saltar al contenido

Listar formulários

GET/api/forms

Auth
Requiere token
Quién puede:
owner
Clave de API:
No acepta clave de API
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

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.

Parámetros

NombreDóndeTipoDescripción
spaceIdopcionalquerystring (uuid)
statusopcionalquerydraft | open | closed
includeDeletedopcionalqueryboolean
pageopcionalqueryinteger
limitopcionalqueryinteger

Headers

NombreTipoDescripción
X-CommunityIdopcionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Respuestas

CódigoDescripción
200Os formulários.
401Token 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`).
403Autenticado, mas sem permissão para esta operação.
422Espaço que não é de formulários, ou `status` inválido.

Ejemplo con curl

curl -X GET "https://api.memberfy.net/api/forms" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"