Skip to main content
GET
Get a workflow

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
string
required
Pattern: ^[0-9a-fA-F]{24}$

Query Parameters

versionId
string

Retrieve the workflow with a specific version

Pattern: ^[0-9a-fA-F]{24}$
versions
enum<string>[]
Available options:
draft,
live,
inactive
select
string[]

List of fields you want to get, by default the whole workflow with versions is returned. But you can choose to return only ['name'] to have data: [{ id: 'bar', name: 'foo' }]. Note: id is always returned

Response

Ok

status
enum<string>
required
Available options:
success
program
string
required
version
string
required
datetime
string
required
message
string
required
data
object
required
code
number