Skip to main content
A Workflow defines the sequence of milestones a project moves through for a company. Workflows are read-only through the Workflows endpoints.
id
integer

The workflow's unique identifier.

Example:

58

tenant_id
integer

The id of your organization's account.

Example:

12

company_id
integer

The id of the company this workflow belongs to.

Example:

6

name
string

The workflow's name.

Example:

"Roof Replacement - Retail"

comment
string | null

Free-form notes about the workflow. Null if not set.

Example:

"Standard retail roofing workflow"

is_active
boolean

Whether the workflow is active. Only active workflows can be selected when creating a project.

Example:

true