Skip to content

Lista sections & spaces

GET/api/spaces

Auth
Public
X-CommunityId
X-CommunityId Send 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.

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

A lista é filtrada por quem pergunta. Um item `private` que o leitor não alcança **some** quando o que o fecha é um grupo de membros, e **volta com `locked: true` e `lockReason`** (`product` ou `subscription`) quando o que o fecha pode ser comprado — esconder a oferta seria esconder a venda. Owner, admin e moderator recebem tudo.

A resposta traz, **para quem administra**, os campos opcionais novos `access` (o que o próprio space exige), `requiredBySection` (o que a seção exige — combina com **E**, não é mais item da mesma lista, e vem com `sectionId`, `sectionTitle` e `visibility`) e `accessFromProducts` (os produtos ligados pela tela de produtos, que a tela de space não edita).

Parameters

NameInTypeDescription
sectionIdoptionalquerystring (uuid)Valid section ID is required
moduleoptionalquerystringInvalid module type
visibilityoptionalquerypublic | members | plan | privateInvalid visibility value

Headers

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

Responses

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

curl example

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