Aller au contenu

Lista ou consulta customers

GET/api/dashboard/customers

Auth
Jeton requis
Clé d’API:
reports:read
X-CommunityId
X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

Owner, admin e financeiro. Os clientes pagantes da comunidade: pessoas e empresas que pagaram, a empresa pelo nome e com o e-mail de cobrança. Cada item traz `type` (`member` ou `company`), `id`, `name`, `email`, `avatar`, `totalRevenue`, `totalPurchases`, `activeSubscriptions`, `subscriptions` e `lastPurchase`. A ordem (`sortBy` `revenue` ou `purchases`, `order`) vale para a lista inteira antes da página.

En-têtes

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

Réponses

StatutDescription
200Operação realizada com sucesso.
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`).
500Erro interno do servidor.

Exemple curl

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