Saltar al contenido

Como a comunidade aparece no diretório da Memberfy

GET/api/hub-listing

Auth
Requiere token
Clave de API:
community:read
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.

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

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
200A configuração atual.
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.
500Erro interno do servidor.

Ejemplo con curl

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