Lista os alunos de um curso
GET/api/courses/{id}/enrollments
- Auth
- Jeton requis
- Qui peut l’appeler:
- owner
- admin
- moderator
- finance
- SuperAdmin
- Clé d’API:
- courses:read
- X-CommunityId
X-CommunityIdEnvoyez 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.
A aba **Alunos**. Só owner, admin, moderador e financeiro (somente leitura; o SuperAdmin passa como owner). Membro, 403; curso de outra comunidade (`X-CommunityId`), 404. Paginada, **sem busca**, do mais recente para o mais antigo.
**O que entra:** matrículas `enrolled` e `completed` de perfis que ainda existem. A matrícula `cancelled` **não** é listada nem contada. O `pagination.totalCount` é o mesmo número de `stats.enrollments` do `GET /api/courses/{id}`. (O `courses_report` do MCP usa outra janela e não é comparável.)
Cada linha traz a pessoa, a data de matrícula, as aulas concluídas e o total de aulas **que existem hoje**, o percentual, a última atividade e se concluiu.
Paramètres
| Nom | Emplacement | Type | Description |
|---|---|---|---|
idobligatoire | path | string (uuid) | |
pagefacultatif | query | integer | |
limitfacultatif | query | integer |
En-têtes
| Nom | Type | Description |
|---|---|---|
X-CommunityIdfacultatif | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Réponses
| Statut | Description |
|---|---|
200 | Página de alunos. |
400 | Requisição inválida — falha de validação. |
401 | Token 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`). |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
500 | Erro interno do servidor. |
Exemple curl
curl -X GET "https://api.memberfy.net/api/courses/<id>/enrollments" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"