Saltar para o conteúdo

A árvore de objetivos do ciclo

GET/api/goals/cycles/{cycleId}/objectives

Auth
Exige token
Chave de API:
Não aceita chave de API
X-CommunityId
X-CommunityId Envie o X-CommunityId da comunidade em que a operação acontece.

Quem abre o espaço. A árvore empresa → grupo → pessoa, com progresso e farol de cada objetivo e KR. Objetivo restrito só vem para o dono, os líderes dele (diretos e indiretos) e owner/admin; um objetivo cujo pai quem pede não vê vira raiz. `groupId` e `ownerId` (dono do objetivo ou de um KR dele) filtram, mantendo os objetivos de cima.

Parâmetros

NomeOndeTipoDescrição
cycleIdobrigatóriopathstring (uuid)
groupIdopcionalquerystring (uuid)
ownerIdopcionalquerystring (uuid)

Headers

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

Respostas

CódigoDescrição
200`{ cycle, tree: [Objective + children], total }`.
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.
500Erro interno do servidor.

Exemplo com curl

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