List drip workflows

Search Documentation

Search across all developer documentation

workflows

List drip workflows

GET /v1/workflows
Auth required api.workflows.view

Returns the org's drip-workflow definitions — metadata only. The .flow source is never exposed (authoring stays in the dashboard or a connected git repo). Each entry carries its by-status run tally in run_counts. Ordered by name.

Query parameters

limit integer optional

Page size (1–200). Default 50.

Responses

Errors follow the RFC 7807 problem format — see the error reference.

200 A page of workflow definitions application/json
data array<object> required

Each entry in data:

id string<uuid> required
name string required
key string required

The workflow's stable slug within the org.

description string optional
status string required

Lifecycle status: draft, active, paused, archived, or invalid.

invalid_reason string optional

Present only when status is invalid.

require_send_approval boolean optional

When true, sends are held for manual review instead of dispatching automatically.

current_version integer required

The live definition version.

origin string enum required

managed (authored in-app) or git (defined in a connected repo, read-only).

One of: managed, git

source_path string optional

Repo-relative path of the .flow file (git-backed only).

source_url string optional

"Edit in provider" deep link (git-backed only).

run_counts object required

By-status run tally, e.g. active/completed → counts. Always present.

created_at string<date-time> required
updated_at string<date-time> required
pagination object required

Fields of pagination:

has_more boolean required
next_cursor string | null optional
401 Missing, malformed, or unknown API key application/problem+json
403 Key lacks the required scope or plan limit violated application/problem+json
429 Per-org rate limit exceeded application/problem+json
500 Unexpected server-side failure. The code is internal_error. The request_id field can be quoted to SendOps support to investigate. application/problem+json