flows.get
Ver flow. O flow com o rascunho atual (draft, a versão mais recente se ainda não publicada) e a versão publicada (published).
- Endpoint:
POST https://app.atomiks.com.br/api/v1/flows.get(corpo JSON) - Quem pode chamar: membro da conta
- Escopo da chave:
automations:read - Grava dados: não
- Pela chave de API: sim
- Ferramenta MCP:
flows_get - Ficha em JSON:
https://app.atomiks.com.br/api/v1/openapi.json(operationIdflows.get)
Entrada
| Campo | Tipo | Obrigatório | Nota |
|---|---|---|---|
id | string (uuid) | sim |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"id"
]
}Exemplo
curl -X POST https://app.atomiks.com.br/api/v1/flows.get \
-H "Authorization: Bearer $ATOMIKS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"id":"00000000-0000-0000-0000-000000000000"}'CLI:
node cli/atomiks.mjs flows.get --json '{"id":"00000000-0000-0000-0000-000000000000"}'MCP: ferramenta flows_get com a mesma entrada.
Saída
Sucesso: {"data": ...} com o formato abaixo.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
]
},
"publishedVersion": {
"type": [
"number",
"null"
]
},
"folder": {
"type": [
"string",
"null"
]
},
"latestVersion": {
"type": [
"number",
"null"
]
},
"hasDraft": {
"type": "boolean"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"draft": {
"anyOf": [
{
"type": "object",
"properties": {
"version": {
"type": "number"
},
"graph": {},
"published": {
"type": "boolean"
},
"publishedAt": {
"type": [
"string",
"null"
]
},
"createdAt": {
"type": "string"
}
},
"required": [
"version",
"graph",
"published",
"publishedAt",
"createdAt"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"published": {
"anyOf": [
{
"type": "object",
"properties": {
"version": {
"type": "number"
},
"graph": {},
"published": {
"type": "boolean"
},
"publishedAt": {
"type": [
"string",
"null"
]
},
"createdAt": {
"type": "string"
}
},
"required": [
"version",
"graph",
"published",
"publishedAt",
"createdAt"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"status",
"publishedVersion",
"folder",
"latestVersion",
"hasDraft",
"createdAt",
"updatedAt",
"draft",
"published"
],
"additionalProperties": false
}Erros
{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).