Workflow object

_id

string

Unique workflow identifier

name

string

Workflow name (unique within organization)

organizationId

string

Organization identifier

steps

object[]

Array of workflow steps with field schemas

Show child attributes

steps.flowId

string

required

Flow identifier for this step (must exist)

steps.flowName

string

Flow display name (auto-populated)

steps.assigneeId

string

Default assignee user ID (optional, must exist)

steps.statusMapping

string

Status mapping configuration (optional)

steps.fieldMappings

object[]

Field mappings from previous steps (only for step 2+)

Show child attributes

steps.fieldMappings.sourceField

string

Source field in format: $refFlow.fieldId or fieldId

steps.fieldMappings.sourceStep

integer

Source step index (must be < current step)

steps.fieldMappings.targetField

string

Target field in current step

steps.fieldMappings.sourceType

enum<string>

Source type for mapping

Available options:

manual,

step,

direct

steps.fieldSchema

object[]

Available fields for this step (auto-populated from flow)

steps.order

integer

Step order index (0-based, auto-populated)

steps.createdAt

string<date-time>

steps.updatedAt

string<date-time>

customStatuses

object[]

Custom status definitions

Show child attributes

customStatuses.name

string

required

Custom status name

Required string length: 1 - 50

customStatuses.isDefault

boolean

default:false

Whether this is a default status

customStatuses.createdAt

string<date-time>

customStatuses.updatedAt

string<date-time>

createdBy

string

Creator email

updatedBy

string

Last updater email

createdTime

string<date-time>

updatedTime

string<date-time>

Getting Started

Webhook

Task

Routing

Flow

Data

Setting

File

Billing

Dashboard

Authentication

Reference

Internal Tools

Objects