Skip to main content
GET
Get Workflow

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workflow_id
string
required

The workflow's ID, which GET /v1/workflows returns as id. The workflow fields on an app or entitlement carry the same id.

Response

Successful Response

Response shape for a Workflow.

id
string
required

A UUID identifying this Workflow.

type
enum<string>
required

The kind of workflow.

Available options:
approval,
approval-chain,
entitlement-provisioning,
entitlement-deprovisioning,
account-provisioning,
account-deprovisioning
steps
WorkflowStepOutput · object[]
required

The ordered steps of the workflow.

name
string | null

A name for this Workflow.

description
string | null

A description of this Workflow.

app_id
string | null

UUID of the app this Workflow belongs to, if associated.