Skip to main content
GET
Find a specific step.

Authorizations

Authorization
string
header
required

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

Path Parameters

stepId
string
required

ID of the step to return.

Response

OK

An entity to store details about a specific step within a workflow

stepType
enum<string>
required

Step type. Advisory on writes. The server resolves the persisted step's type from the step id and ignores any client-supplied value.

Available options:
ORIGIN,
CHAIN,
END
name
string
required

Step name.

description
string
required

Description of the step.

priority
integer<int32>
required

Determines the step's place in the workflow. Priority is in descending order with 0 being the first step.

userGroupOperationType
enum<string>
required

Determine how users are able to interact with user groups on the step. By default, new steps will allow FULL_ACCESS user group editing.

Available options:
FULL_ACCESS,
ADD_ONLY,
READ_ONLY
xpos
integer<int32>
required

Vertical position of the step on the process screen.

ypos
integer<int32>
required

Horizontal position of the step on the process screen.

isPublic
boolean
required

Allows a step to become a public step. Public steps allow for a shareable public record link to be generated in the step edit screen. Public steps do not require any login credentials.

commentsEnabled
boolean
required

Allows comments to be displayed on a step.

documentsEnabled
boolean
required

Allows documents to be generated on a step.

externalUserMfaRequired
boolean
required

Whether or not to require MFA for external users to access this step.

uxriEnabled
boolean
required

Whether or not to enable UXRI on the step.

autofillEnabled
boolean
required

Whether or not to enable autofill on the step.

sla
object
required

Object containing all SLA information.

workflow
object
required

Workflow that the step belongs to.

assignableUserType
enum<string>
required

Determine what users are able to be assigned to a record. By default, new records will allow APP_USERS as assignees.

Available options:
APP_AND_EXTERNAL_USERS,
APP_USERS,
EXTERNAL_USERS
id
string
required
active
boolean
required
created
string<date-time>
required
updated
string<date-time>
required
end
boolean
origin
boolean
chain
boolean