Saltar al contenido

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

GET/api/goals/cycles

Auth
Requiere token
Clave de API:
No acepta clave de API
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

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

Parámetros

NombreDóndeTipoDescripción
spaceIdopcionalquerystring (uuid)
statusopcionalqueryOPEN | CLOSED

Headers

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

Respuestas

CódigoDescripción
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.

Ejemplo con curl

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