The Workflows API methods allow users to programmatically read the varying lifecycles that tasks take in the Urgent platform.

Read Workflows by Tenant

GET /workflows/{tenant}/{type}

This method gets a list of all the Workflows of the type specified by the type variable. Current supported types are reactive, scheduled and invoicing.

GET /workflows/{tenant}/{type}/{workflow}

This method allows you to get a singular Workflow if you know the name of the workflow you are requesting.

Response Objects

Parent	Property	Notes
Workflows[]	Name	The name of the workflow, unique per tenant
Workflows[]	WorkflowType	The type task the workflow is for. Either Reactive, Scheduled or Invoice
Workflows[]	IsActive	Determines if a workflow is active. Existing tasks can run on an inactive workflow.
Workflows[]	IsDefault	During the creation of a task if no other rules set the workflow then this one will be used.
Workflows[]	Statuses[]	An array of statues that a task can move through.
Statuses[]	Name	The name of the status.
Statuses[]	StatusType	All statuses fall into one of four types - New, Open, Closed or Cancelled
Statuses[]	IsQuotationEnabled	If TRUE then a quote can be added to a task when it is in this status
Statuses[]	IsManualDateEnabled	If TRUE then the StatusChangeDateTimeUtc property on the Change Status method can be populated
Statuses[]	IsEligibleToInvoice	If TRUE then a task can be invoiced when in this status, provided it meets other criteria.
Statuses[]	Destinations[]	An array of status names that tasks in this status can transition to.
Statuses[]	IsTaskResolutionCauseEnabled	If TRUE then the Task Resolution Cause information must be populated
Statuses[]	IsTaskResolutionRemedyEnabled	If TRUE then the Task Resolution Remedy information must be populated
Statuses[]	UpdateAssetCondition	If TRUE then the Asset Condition Survey information must be populated
Statuses[]	SupplierOnSite	If TRUE then the Supplier has arrived at the site when this status is selected
Statuses[]	CreateTaskPermit	If TRUE then triggers the Create Task Permit steps as part of the status change in Urgent
Statuses[]	CloseTaskPermit	If TRUE then triggers the Close Task Permit steps as part of the status change in Urgent