Lista os ciclos de Metas & OKRs de um espaço
GET/api/goals/cycles
- Auth
- Requires a token
- API key:
- No API key accepted
- X-CommunityId
X-CommunityIdSend 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.
Quem abre o espaço (os outros: 404). `spaceId` é opcional enquanto a comunidade tem um só espaço Metas & OKRs (com vários: 422 `spaceRequired`).
Parameters
| Name | In | Type | Description |
|---|---|---|---|
spaceIdoptional | query | string (uuid) | |
statusoptional | query | OPEN | CLOSED |
Headers
| Name | Type | Description |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Responses
| Status | Description |
|---|---|
200 | Ciclos, mais recentes primeiro, cada um com o `summary` (progresso geral, nota OKR de 0 a 1, KRs atingidos (>= 0,7), em progresso e não atingidos, KRs sem check-in no período, os de quem pede e os principais objetivos, só do que quem pede pode ler) e o `nextReminderOn`; `permissions.canCreateCycle` diz se quem pede cria ciclo (owner/admin), mesmo com a lista vazia. |
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. |
422 | `spaceRequired`. |
500 | Erro interno do servidor. |
curl example
curl -X GET "https://api.memberfy.net/api/goals/cycles" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"