Skip to main content
POST
workflow.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
workflowId
string
required

Record ID in your connected account.

Required string length: 1 - 250
Pattern: ^[A-Za-z0-9_-]+$

Response

The result

workflowId
string
required

Workflow ID in your connected account.

Required string length: 1 - 250
Pattern: ^[A-Za-z0-9_-]+$
name
string
required

Display name.

Required string length: 1 - 250
active
boolean
required

Whether the workflow is published and enabled.

archived
boolean

Whether the workflow is archived.

stepCount
integer

Number of steps.

Required range: 0 <= x <= 9007199254740991
triggerCount
integer

Number of trigger steps.

Required range: 0 <= x <= 9007199254740991
createdAt
string<date-time>

Time in ISO 8601 format.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
updatedAt
string<date-time>

Time in ISO 8601 format.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
steps
object[]

Optional neutral graph projection. Sources without a projection omit it.

Maximum array length: 500

Optional projected graph connections.

Maximum array length: 5000
groups
object[]

Optional visual groups.

Maximum array length: 500
settings
object

Optional neutral execution settings.

versionId
string

Current draft version ID.

Required string length: 1 - 250
Pattern: ^[A-Za-z0-9_-]+$