Saltar al contenido

Devolve o organograma da comunidade

GET/api/hierarchy/org-chart

Auth
Requiere token
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.

Lista **plana** de nós, cada um com o seu `reportsToId` — a árvore e o canvas montam a sua forma a partir dela em uma passada. Nunca carrega a comunidade inteira por padrão: começa de uma pessoa (`rootProfileId`) ou de um grupo (`groupId`), desce `depth` níveis e para no teto de `limit`, devolvendo `truncated: true` em vez de cortar em silêncio. Cada nó traz `hasUnloadedReports`, que é o que diz à tela se a caixa ainda abre.

Parámetros

NombreDóndeTipoDescripción
rootProfileIdopcionalquerystring (uuid)Começa o desenho nesta pessoa. Sem ele, começa por quem não responde a ninguém.
groupIdopcionalquerystring (uuid)Desenha só um grupo: quem está nele, tendo como raiz quem responde a alguém de fora.
depthopcionalqueryinteger
limitopcionalqueryinteger

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
200Operação realizada com sucesso.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
500Erro interno do servidor.

Ejemplo con curl

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