Axuz Developers

GET /teams/{teamId}/flowcharts/{id}

Retorna flowchart completo (com document).

  • Acesso: Membro da equipe
  • Serviço: https://api-flow.axuz.net

Autenticação aceita

  • sessionCookie — Sessão plena Axuz (cookie de sessão da casa). Sessão restrita é 403 enrollment_required.
  • bearerSession — JWT de acesso da sessão em `Authorization: Bearer`.

Serve GET /teams/{teamId}/flowcharts/{id} — devolve o Flowchart completo (com document + version).

Motivo: primeira carga do editor. Distinção NotFound (404) vs erro DB (500) explícita pro cliente.

Entradas: URL {teamId}/{id}, JWT.

Retorno: 200 Flowchart, 404 quando não existe/soft-delete, 500 DB.

Parâmetros

NomeEmTipoObrigatórioDescrição
teamIdpathstringsim
idpathstringsim

Respostas

200

OK.

NomeTipoObrigatórioDescrição
idstring<uuid>sim
team_idstring<uuid>sim
created_bystring<uuid>sim
titlestringsim
documentFlowDocumentsim

Shape enxuta espelhando lib/types.ts:FlowDocument no client. Backend não valida a shape interna (opaco pro storage); os campos abaixo são o mínimo comum consumido pelo editor.

document.nodesarray<FlowNode>sim
document.nodes[].idstringsim
document.nodes[].typestringsim
document.nodes[].positionFlowXYsim
document.nodes[].position.xnumbersim
document.nodes[].position.ynumbersim
document.nodes[].widthinteger | nullnão
document.nodes[].heightinteger | nullnão
document.nodes[].parentNodestringnão
document.nodes[].extentstringnão
document.nodes[].dataobjectsim
document.nodes[].styleobjectnão
document.edgesarray<FlowEdge>sim
document.edges[].idstringsim
document.edges[].sourcestringsim
document.edges[].targetstringsim
document.edges[].typestringnão
document.edges[].dataobjectnão
versionintegersim
public_share_tokenstring | nullnão

Legacy single-token share.

public_share_expires_atstring<date-time> | nullnão
has_sharebooleansim
created_atstring<date-time>sim
updated_atstring<date-time>sim

400

Payload inválido.

NomeTipoObrigatórioDescrição
errorstringsim

401

JWT ausente/expirado.

NomeTipoObrigatórioDescrição
errorstringsim

403

Sem permissao (nao e owner/admin; token sem escopo; token de integracao em rota nao permitida)

NomeTipoObrigatórioDescrição
errorstringsim

404

Recurso não encontrado ou fora de escopo.

NomeTipoObrigatórioDescrição
errorstringsim

429

Limite de requisições excedido.

NomeTipoObrigatórioDescrição
errorstringsim

500

Falha inesperada (log + trace).

NomeTipoObrigatórioDescrição
errorstringsim

Exemplos

O "Try it" está desligado nesta referência. Use os exemplos com a sua credencial de teste.

curl

curl -sS -X GET 'https://api-flow.axuz.net/teams/TEAM_ID/flowcharts/ID' \
  -H "Authorization: Bearer $AXUZ_TOKEN"

Node.js

const res = await fetch("https://api-flow.axuz.net/teams/TEAM_ID/flowcharts/ID", {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());

Python

import os
import requests

res = requests.request(
    "GET",
    "https://api-flow.axuz.net/teams/TEAM_ID/flowcharts/ID",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())