Skip to content

Minhas notificações nesta comunidade

GET/api/notifications

Auth
Requires a token
API key:
No API key accepted
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.

Qualquer papel; só as notificações de quem pergunta, no `X-CommunityId`, a mais recente primeiro, por cursor (`pagination.nextCursor`, até 50 por página). `pagination.unreadCount` traz o total de não lidas. `unread=true` só as não lidas; `type` filtra um tipo. Em tempo real chegam pelo socket do chat (`notification.new`, `notification.read`, `notification.removed`). Quando o motivo some (um pedido de conexão cancelado ou aceito), a notificação some junto.

Parameters

NameInTypeDescription
cursoroptionalquerystringO `nextCursor` da página anterior.
limitoptionalqueryinteger
unreadoptionalqueryboolean
typeoptionalquerystring

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
200Notificações.
400Requisição inválida — falha de validação.
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.

curl example

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