Skip to content

O meu link de indicação e quantas pessoas indiquei

GET/api/referrals/me

Auth
Requires a token
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 membro da comunidade do `X-CommunityId`. Com a indicação ligada: `code` (criado na primeira leitura, único na comunidade), `path` (`/?ref=<code>`, o app junta o domínio da comunidade) e `count` (quantas pessoas viraram membro pelo link). Desligada: `enabled: false`, sem código. Quem a pessoa indicou nunca aparece aqui: só a equipe vê (`GET /api/referrals/report` e `referredBy` no perfil).

O link leva ao cadastro normal da comunidade: o app guarda o código por 30 dias e o manda em `POST /api/auth/register` (ou `POST /api/auth/signup-request`) como `referralCode`, com `referralSeenAt`.

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
200O link e a contagem.
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/referrals/me" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"