Skip to main content
GET
Get workflow

Authorizations

Authorization
string
header
required

Organization API key, generated in studio.sidenet.ai. Backend only — never in a browser.

Path Parameters

id
string
required
Example:

"4c2f9e18-7a63-4d05-b1e8-93a7c0f2d641"

Query Parameters

version
string

Which version of the workflow to return. Takes any of: a version number (3, or v3); 0 or draft for the unpublished draft; latest for the newest published version; active for the one serving traffic; or the version row's uuid. Defaults to active, falling back to the draft when nothing has been activated yet.

Example:

"active"

Response

The workflow and the version that was selected

workflow
object
version
object | null

The one version this call selected, in full — the version that runs by default, or whatever version named. version_number says which it is (0 is the draft). Null only for a workflow with neither an active version nor a draft.