Vai al contenuto

Lista os ciclos de Metas & OKRs de um espaço

GET/api/goals/cycles

Auth
Richiede un token
Chiave API:
Non accetta chiavi API
X-CommunityId
X-CommunityId Invia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.

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`).

Parametri

NomeDoveTipoDescrizione
spaceIdfacoltativoquerystring (uuid)
statusfacoltativoqueryOPEN | CLOSED

Header

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

Risposte

CodiceDescrizione
200Ciclos, 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.
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.
404Recurso não encontrado.
422`spaceRequired`.
500Erro interno do servidor.

Esempio con curl

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