Skip to main content
Fetch a single workflow by its ID.

​
Overview

The Get Workflow endpoint returns the full definition and metadata for one workflow, including its JSON definition, current status, and any linked saved search.

​
Authentication

Requires a valid API key. No special permission scope is needed beyond a valid key.

​
Key Features

  • Full Workflow Definition: Complete JSON definition, status, and linked search
  • No Credit Cost: This endpoint is free to use
curl -X GET "https://api.trigify.io/v1/workflows/wf_abc123" \
  -H "x-api-key: YOUR_API_KEY"

​
Path Parameters

ParameterTypeDescription
idstringThe unique workflow ID

​
Example Response

{
  "message": "Workflow retrieved successfully",
  "success": true,
  "data": {
    "id": "wf_abc123",
    "name": "Summarise new posts to Slack",
    "description": "AI-summarise each new post and post the summary to Slack",
    "workflow": {
      "trigger": { "kind": "workflows/new-post", "inputs": {} },
      "actions": [
        {
          "id": "agent-1",
          "kind": "generic_agent",
          "name": "Summarise Post",
          "inputs": {
            "outputFormat": "text",
            "model": "openai/gpt-5-mini",
            "prompt": "Summarise this social post in two concise bullet points: {{ !ref($.trigger.outputs.text) }}"
          }
        },
        {
          "id": "slack-1",
          "kind": "slack_send_channel_message",
          "name": "Send Summary",
          "inputs": {
            "channel": "#social-alerts",
            "message": "New post summary: {{ !ref($.agent-1.result.output) }}"
          }
        }
      ],
      "edges": [
        { "from": "$source", "to": "agent-1" },
        { "from": "agent-1", "to": "slack-1" }
      ]
    },
    "enabled": true,
    "status": "PUBLISHED",
    "social_saved_search_id": "ss_xyz456",
    "created": "2026-04-01T10:00:00.000Z",
    "updated": "2026-04-12T14:20:00.000Z"
  }
}

​
Response Fields

FieldTypeDescription
messagestringHuman-readable status message
successbooleantrue on success
dataobjectThe workflow (see below)
The data object contains:
FieldTypeDescription
idstringUnique workflow identifier
namestringWorkflow name
descriptionstringWorkflow description
workflowobjectWorkflow definition (JSON) with trigger, actions, and edges. See Create Workflow for the full shape
enabledbooleanWhether the workflow is active
statusstringWorkflow status (DRAFT or PUBLISHED)
social_saved_search_idstring | nullLinked saved search ID, if any
createdstringISO 8601 creation timestamp
updatedstringISO 8601 last update timestamp

​
Credit Usage

This endpoint is free and does not consume credits.