Como a comunidade aparece no diretório da Memberfy
GET/api/hub-listing
- Auth
- Requires a token
- API key:
- community:read
- 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.
Owner e admin da comunidade do `X-CommunityId`; moderador, financeiro e membro recebem 403. Traz a opção "Listar no diretório da Memberfy" (ligada por padrão), a categoria, a capa, se mostra o número de membros, as categorias aceitas com o rótulo traduzido e, quando a Memberfy retirou a comunidade do diretório, `delisted` com a data e o motivo.
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 | A configuração atual. |
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. |
curl example
curl -X GET "https://api.memberfy.net/api/hub-listing" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"