Zum Inhalt springen

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

GET/api/goals/cycles

Auth
Token erforderlich
API-Schlüssel:
Kein API-Schlüssel möglich
X-CommunityId
X-CommunityId Sende die X-CommunityId der Community, in der die Operation stattfindet.
Die Beschreibungen der Endpoints stammen aus der API-Spezifikation und sind vorerst auf Portugiesisch. Die Oberfläche drumherum ist übersetzt.

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

Parameter

NameOrtTypBeschreibung
spaceIdoptionalquerystring (uuid)
statusoptionalqueryOPEN | CLOSED

Header

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

Antworten

StatusBeschreibung
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.

curl-Beispiel

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