Skip to main content
GET
Get a Workflow

Authorizations

Authorization
string
header
required

Your API key (ta_live_…) from Settings → API keys, sent as Authorization: Bearer <key>. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with 403.

Headers

Thinnest-Workspace
string

Developers only: the customer workspace this request acts in — its org_… id from POST /customers. Leave it out to act in your own workspace. Refused with 404 (Workspace not found.) when the id is unknown, is not one of your customers, or is not an org_… id; 410 when that customer was deleted (restore it with POST /customers/{id}/restore until it is erased); 403 when the key belongs to one customer workspace (it cannot act as another); 400 when your workspace is not a developer workspace. /customers/* and GET /customers/usage are your own workspace's and refuse the header with 400: call them without it.

Example:

"org_3fKq9TzQ1mN8vB2xR7cLpA"

Path Parameters

workflowId
string
required

The workflow's id (wf_…); a bare uuid also works.

Response

The workflow.

id
string
required

wf_…

name
string
required
status
enum<string>
required

draft: never published; active: new runs start; paused: runs wait where they are.

Available options:
draft,
active,
paused
version
integer | null
required

The published version new runs start on; null before the first publish.

trigger
object
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
blocks
object[]
required
startUrl
string | null
required

For a workflow your system starts: where to POST runs. Null otherwise.