Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB
Workflows

Get workflow details

Returns a workflow automation. Pass includeNodes=true to include graph nodes.

get/public/v1/workflows/{workflowId}

Path parameters

workflowIdnumber nullable
Example:42

Query parameters

boolean
OR
string
Example:example

Response

Workflow details

idnumber required
namestring required
descriptionstring nullable required
status'ACTIVE' | 'DELETED' | 'DRAFT' required
triggerType'CONVERSATION_ENDED' | 'CONTACT_CREATED' | 'CONTACT_UPDATED' | 'FEEDBACK_CAPTURED' | 'INCOMING_WEBHOOK' | 'TABLE_ROW_CREATED' | 'OBJECT_RECORD_CREATED' | 'TABLE_ROW_UPDATED' | 'OBJECT_RECORD_UPDATED' | 'SCHEDULED_TRIGGER' | 'CONVERSATION_IDLE' | 'COMPOSIO_TRIGGER' nullable required
createdAtstring required
updatedAtstring required
runsCountnumber required
runsFailedCountnumber required
lastRunDatestring nullable required
liveSnapshotIdstring nullable required
draftSnapshotIdstring nullable required

Example response

{
  "id": 501,
  "name": "Daily CRM Sync",
  "description": "Syncs contacts to HubSpot",
  "status": "ACTIVE",
  "triggerType": "CONVERSATION_ENDED",
  "createdAt": "2024-01-01T12:00:00Z",
  "updatedAt": "2024-01-01T12:00:00Z",
  "runsCount": 1200,
  "runsFailedCount": 5,
  "lastRunDate": "2024-01-01T12:00:00Z",
  "liveSnapshotId": "64f1c2e6a75f2d4a9a2f1234",
  "draftSnapshotId": "64f1c2e6a75f2d4a9a2f1234",
  "nodes": [
    {
      "nodeId": "node_550e8400-e29b-41d4-a716-446655440000",
      "alias": "Initial trigger",
      "name": "Initial trigger",
      "position": {
        "positionX": 1,
        "positionY": 1
      },
      "type": "TRIGGER",
      "data": {
        "type": "TRIGGER",
        "triggerType": "CONVERSATION_ENDED",
        "triggeredBy": "BOTH",
        "triggeredByAgentIds": [
          "example"
        ],
        "triggerByWebhookIds": [
          "example"
        ],
        "triggeredByTableId": 1,
        "triggeredByRecordTypeId": 1,
        "connectedAccountTriggerId": "example",
        "triggerToolkit": "example",
        "triggerSlug": "example",
        "connectedAccountId": 1
      },
      "workflowId": "example",
      "handles": [
        {
          "handleId": "example",
          "sourceEdge": {
            "from": "example",
            "fromHandleId": "example",
            "to": "example",
            "toHandleId": "example"
          },
          "text": "example"
        }
      ],
      "targetEdges": [
        {
          "from": "example",
          "fromHandleId": "example",
          "to": "example",
          "toHandleId": "example"
        }
      ],
      "createdAt": "example",
      "updatedAt": "example"
    }
  ]
}