Skip to main content
Retrieve a paginated list of workflows in your organisation.

​
Overview

The List Workflows endpoint returns the workflows in your organisation with pagination and an optional status filter. Use it to browse existing workflows, filter drafts from published workflows, or build an index page in your integration.

​
Authentication

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

​
Key Features

  • Pagination: Limit + offset pagination with a has_more flag and total count
  • Status Filtering: Filter by DRAFT or PUBLISHED
  • Full Workflow Shape: Each item includes the complete workflow definition
  • No Credit Cost: This endpoint is free to use
# List first page of workflows
curl -X GET "https://api.trigify.io/v1/workflows?limit=20&offset=0" \
  -H "x-api-key: YOUR_API_KEY"

# Filter by status
curl -X GET "https://api.trigify.io/v1/workflows?status=PUBLISHED" \
  -H "x-api-key: YOUR_API_KEY"

​
Query Parameters

ParameterTypeDefaultDescription
limitinteger20Maximum number of workflows to return (1-100)
offsetinteger0Number of workflows to skip before returning results
statusstring-Filter by status. One of DRAFT or PUBLISHED

​
Example Response

{
  "message": "Workflows retrieved successfully",
  "success": true,
  "data": {
    "items": [
      {
        "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" },
            { "id": "slack-1", "kind": "slack_send_channel_message", "name": "Send Summary" }
          ],
          "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"
      },
      {
        "id": "wf_def789",
        "name": "Lead scoring draft",
        "description": "Score inbound leads via AI",
        "workflow": {
          "trigger": { "kind": "workflows/new-post", "inputs": {} },
          "actions": [],
          "edges": []
        },
        "enabled": false,
        "status": "DRAFT",
        "social_saved_search_id": null,
        "created": "2026-04-14T09:00:00.000Z",
        "updated": "2026-04-14T09:00:00.000Z"
      }
    ],
    "has_more": true,
    "total": 42
  }
}

​
Response Fields

FieldTypeDescription
messagestringHuman-readable status message
successbooleantrue on success
dataobjectPaginated result (see below)
The data object contains:
FieldTypeDescription
itemsarrayWorkflows on the current page
has_morebooleanWhether more workflows exist beyond this page
totalintegerTotal number of workflows matching the filter
Each item in items matches the shape of Get Workflow:
FieldTypeDescription
idstringUnique workflow identifier
namestringWorkflow name
descriptionstringWorkflow description
workflowobjectWorkflow definition (JSON)
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.