Devolve o organograma da comunidade
GET/api/hierarchy/org-chart
- Auth
- Jeton requis
- Clé d’API:
- community:read
- X-CommunityId
X-CommunityIdEnvoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.
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 (`rootMemberId`) 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.
Paramètres
| Nom | Emplacement | Type | Description |
|---|---|---|---|
rootMemberIdfacultatif | query | string (uuid) | Começa o desenho nesta pessoa. Sem ele, começa por quem não responde a ninguém. |
groupIdfacultatif | query | string (uuid) | Desenha só um grupo: quem está nele, tendo como raiz quem responde a alguém de fora. |
depthfacultatif | query | integer | |
limitfacultatif | query | integer |
En-têtes
| Nom | Type | Description |
|---|---|---|
X-CommunityIdfacultatif | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Réponses
| Statut | Description |
|---|---|
200 | Operação realizada com sucesso. |
401 | Token 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`). |
403 | Autenticado, mas sem permissão para esta operação. |
500 | Erro interno do servidor. |
Exemple curl
curl -X GET "https://api.memberfy.net/api/hierarchy/org-chart" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"