PEPINO ZAPdocs
Referência da APIFluxos

Detalha um fluxo (com os nos)

Ver como Markdown
GET
/v1/flows/{id}

Retorna o fluxo e a lista de nos (com posicao no canvas, conteudo e a ligacao proximoNodeId). E o que o editor visual carrega para desenhar o diagrama.

Authorization

bearerAuth
AuthorizationBearer <token>

API key enviada como Authorization Bearer pzk_live_... ou pzk_test_...

In: header

Path Parameters

id*string

Identificador do fluxo.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/flows/string"
{
  "flow": {
    "id": "string",
    "instanceId": "string",
    "name": "string",
    "triggerType": "any",
    "triggerValue": "string",
    "active": true
  },
  "nodes": [
    {
      "id": "string",
      "tipo": "message",
      "nome": "string",
      "conteudo": {},
      "posicaoX": 0,
      "posicaoY": 0,
      "ordem": 0,
      "proximoNodeId": "string"
    }
  ]
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key ausente ou invalida"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Projeto inativo ou sem permissao"
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Instancia nao encontrada"
  }
}