Lista os campos customizados da comunidade
GET/api/member-fields
- Auth
- Jeton requis
- Clé d’API:
- members:read
- X-CommunityId
X-CommunityIdEnvoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.
Owner, admin, moderador e financeiro (o membro recebe 403). Os campos ativos, na ordem de exibição. `key` é o slug do rótulo (`[a-z0-9_]`, até 57 caracteres, `_2` na colisão), não muda depois de criado e forma a variável de campanha `{{campo_<key>}}` (apelido `{{field_<key>}}`). `options` só em `SELECT` e `MULTI_SELECT`; `minSelections` e `maxSelections` só em `MULTI_SELECT` (`null` nos outros); `pattern` e `patternMessage` só em `TEXT`. `askOnSignup` diz se o campo é pedido no cadastro (sempre `true` em campo obrigatório). `hasValues` diz se algum membro já tem valor gravado (aí o tipo não pode mais mudar).
En-têtes
| Nom | Type | Description |
|---|---|---|
X-CommunityIdfacultatif | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Réponses
| Statut | Description |
|---|---|
200 | Os campos. |
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. |
500 | Erro interno do servidor. |
Exemple curl
curl -X GET "https://api.memberfy.net/api/member-fields" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"