Pular para o conteúdo principal
GET
/
workflows
/
{workflowId}
Obter um workflow
curl --request GET \
  --url https://api.altostrat.io/workflows/{workflowId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "fl_01h3j4k5l6m7n8p9q0r1s2t3u4",
  "name": "Integração de Cliente",
  "description": "Envia um e-mail de boas-vindas e configura uma conta.",
  "nodes": [
    {
      "id": "n1",
      "type": "manual_trigger",
      "position": {
        "x": 150,
        "y": 250
      },
      "data": {
        "componentId": "manual_trigger"
      }
    }
  ],
  "edges": [
    {
      "id": "e1-2",
      "source": "n1",
      "target": "n2",
      "sourceHandle": "true"
    }
  ],
  "schedule_type": "manual",
  "schedule_value": "0 9 * * *",
  "next_run_at": "2025-11-01T09:00:00.000000Z",
  "is_active": true,
  "webhook_url": "https://api.altostrat.io/workflows/webhooks/whsec_abc123...",
  "created_at": "2025-10-31T12:00:00.000000Z",
  "updated_at": "2025-10-31T12:30:00.000000Z"
}

Authorizations

​
Authorization
string
header
required

JWT padrão para sessões de usuário obtido via autenticação Altostrat.

Path Parameters

​
workflowId
string
required

O ID prefixado do workflow (ex fl_...).

Response

O objeto do workflow solicitado.

​
id
string

O identificador prefixado único para o workflow.

Example:

"fl_01h3j4k5l6m7n8p9q0r1s2t3u4"

​
name
string

O nome legível do workflow.

Example:

"Integração de Cliente"

​
description
string | null

Uma descrição detalhada do que o workflow faz.

Example:

"Envia um e-mail de boas-vindas e configura uma conta."

​
nodes
object[]

Um array de objetos de nó que compõem o grafo do workflow. Retornado apenas ao obter um único workflow.

​
edges
object[]

Um array de objetos de aresta que conectam os nós no grafo do workflow. Retornado apenas ao obter um único workflow.

​
schedule_type
enum<string> | null

O tipo de agendamento que dispara o workflow.

Opções disponíveis:
manual,
interval,
cron,
daily,
weekly,
monthly
Example:

"manual"

​
schedule_value
string | null

O valor para o agendamento (ex uma expressão cron ou uma string de intervalo como '5 minutes').

Example:

"0 9 * * *"

​
next_run_at
string<date-time> | null

A próxima data e hora agendada para a execução do workflow.

Example:

"2025-11-01T09:00:00.000000Z"

​
is_active
boolean

Indica se o workflow está ativo e pode ser disparado.

Example:

true

​
webhook_url
string<uri> | null

A URL única e segura para disparar este workflow se ele usar um gatilho de webhook.

Example:

"https://api.altostrat.io/workflows/webhooks/whsec_abc123..."

​
created_at
string<date-time>

O timestamp de quando o workflow foi criado.

Example:

"2025-10-31T12:00:00.000000Z"

​
updated_at
string<date-time>

O timestamp da última atualização do workflow.

Example:

"2025-10-31T12:30:00.000000Z"