Clarify API
Workflows

Get a workflow

Returns a single workflow as a JSON:API resource, including its trigger and the blocks that make up its automation graph.

GET
/workspaces/{workspace}/workflows/{id}

Authorization

apiKey
Authorization<token>

API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.

In: header

Path Parameters

workspace*string

The workspace slug — the {slug} segment of your Clarify workspace URL.

id*string

The unique ID of the workflow.

Response Body

application/json

curl -X GET "https://example.com/workspaces/string/workflows/string"
{
  "data": {
    "type": "workflow",
    "id": "f2a4c6e8-0b1d-4e3f-8a5c-7d9e1f3a5b7c",
    "attributes": {
      "_id": "f2a4c6e8-0b1d-4e3f-8a5c-7d9e1f3a5b7c",
      "name": "Create a task for every new deal",
      "description": "When a deal is created, add a follow-up task for the owner.",
      "enabled": true,
      "type": "workflow",
      "published_at": "2026-01-15T09:30:00.000Z",
      "trigger": {
        "_id": "trigger",
        "plugin_id": "on:clarify:create:record",
        "filters": [],
        "input": {
          "entity": "deal"
        },
        "prev": null,
        "next": "create_task"
      },
      "blocks": {
        "create_task": {
          "_id": "create_task",
          "plugin_id": "clarify:create:record",
          "filters": [],
          "input": {
            "entity": "task",
            "attributes": {
              "name": "Follow up on new deal"
            }
          },
          "prev": "trigger",
          "next": null
        }
      },
      "exits": {},
      "run_limits": {},
      "_created_at": "2026-01-15T09:30:00.000Z",
      "_created_by": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81",
      "_updated_at": "2026-02-01T17:45:00.000Z",
      "_updated_by": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81"
    }
  }
}

Delete a workflow

Deletes a workflow. The deletion is applied asynchronously and the response body is empty. This cannot be undone.

List workflows

Returns the workspace’s workflows as an offset-paginated list of JSON:API resources. Use the `type` filter to return only sequences (campaigns) or general workflows.