Devolve o organograma da comunidade
GET/api/hierarchy/org-chart
- Auth
- Requires a token
- X-CommunityId
X-CommunityIdSend the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.
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.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
rootProfileIdoptional | query | string (uuid) | Começa o desenho nesta pessoa. Sem ele, começa por quem não responde a ninguém. |
groupIdoptional | query | string (uuid) | Desenha só um grupo: quem está nele, tendo como raiz quem responde a alguém de fora. |
depthoptional | query | integer | |
limitoptional | query | integer |
Headers
| Name | Type | Description |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Responses
| Status | Description |
|---|---|
200 | Operação realizada com sucesso. |
401 | Token ausente, inválido ou expirado. |
403 | Autenticado, mas sem permissão para esta operação. |
500 | Erro interno do servidor. |
curl example
curl -X GET "https://api.memberfy.net/api/hierarchy/org-chart" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"