Aller au contenu

Lista sections & spaces

GET/api/sections

Auth
Public
Clé d’API:
community:read
X-CommunityId
X-CommunityId Envoyez 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.

Autenticação opcional: o conteúdo retornado varia conforme o membro autenticado.

A lista é filtrada por quem pergunta. Uma seção ou um space que o leitor não abre **volta com `locked: true` e `lockReason`** (`signIn`, `plan`, `product`, `subscription` ou `group`, nunca o nome do grupo) ou **some**, conforme a opção "Para quem não tem acesso" (`lockedDisplay`): `hide` some; `section` mostra só a linha da seção com cadeado, **sem `spaces`**; `section_and_spaces` (padrão) mostra a seção e os spaces com cadeado. O space com cadeado vem só com `id`, `title`, `slug`, `icon`, `description`, `module`, `sectionId`, `locked` e `lockReason`. Área "só administração" (Privada sem ninguém em "Quem tem acesso") nunca vira cadeado. Owner, admin, moderator e finance recebem tudo.

A resposta traz, **para quem administra**, um campo opcional novo `access` com as três listas da concessão (`groups`, `products`, `subscriptionGroups`) e `adminOnly` (`true` quando a seção é Privada sem ninguém em "Quem tem acesso"). Membro comum não recebe: o nome de um grupo já é informação.

Paramètres

NomEmplacementTypeDescription
visibilityfacultatifquerypublic | members | plan | privateInvalid visibility value
isHomefacultatifquerybooleanisHome must be boolean

En-têtes

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

Réponses

StatutDescription
200Operação realizada com sucesso.
400Requisição inválida — falha de validação.
500Erro interno do servidor.

Exemple curl

curl -X GET "https://api.memberfy.net/api/sections" \
  -H "X-CommunityId: $COMMUNITY_ID"