Skip to content

Ranking do curso

GET/api/courses/{courseId}/leaderboard

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.

F-06 fase 2. Os **10 primeiros** alunos por aulas concluídas no curso (empate: quem concluiu a última aula antes), com nome e avatar, e a posição de quem pede (`me`), mesmo fora do top 10. Sai de `lesson_progress`, não dos pontos. Só entram matrículas `enrolled` e `completed` e aulas vivas; quem saiu e a pré-visualização da equipe não entram. O top 10 fica em cache de **60 segundos** por curso; `me` é calculado na hora.

**Opt-in:** o ranking vem desligado; owner e admin ligam com `leaderboardEnabled: true` no curso. Desligado, **403**. Quem lê: a equipe (owner, admin, moderador, financeiro) e o aluno matriculado; os demais, 403.

Parameters

NameInTypeDescription
courseIdrequiredpathstring (uuid)

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 ranking.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
500Erro interno do servidor.

curl example

curl -X GET "https://api.memberfy.net/api/courses/<courseId>/leaderboard" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"