Skip to main content
GET
Get workflow

Authorizations

Authorization
string
header
required

Authenticate with an API access token in the Authorization header: Authorization: Bearer <token>. Create a token from the API Access Tokens page in Contractors Cloud, under Integrations.

Path Parameters

companyId
integer
required

The id of the company.

workflowId
integer
required

The id of the workflow.

Query Parameters

include
string

Comma-separated related resources to embed. Allowed: company.

Response

The requested workflow.

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