Skip to main content

Table api_workflows

The api_workflows table exposes workflow entities, which represent tasks and their progress through defined workflow steps.

Prosper Rabo avatar
Written by Prosper Rabo
Updated this week

⚠️ Important: Some fields in this table will be deprecated on Wednesday, January 7th, 2025. Please review the Deprecated Fields section below and migrate to the recommended alternatives.

Fields

Field Name

Type

Description

workflow_id

Integer

Unique identifier for the workflow

linked_relation_id

Integer

Identifier of the linked relation (customer/contact)

creator_employee_id

Integer

Identifier of the employee who created the workflow

responsible_employee_id

Integer

Identifier of the employee responsible for the current workflow step

linked_project_id

Integer

Identifier of the linked project (if applicable)

linked_sales_id

Integer

Identifier of the linked sale (if applicable)

workflow_type_id

Integer

Identifier of the workflow type

workflow_step_id

Integer

Identifier of the current workflow step

workflow_description

String

Name or description of the workflow

workflow_step

String

Name of the current workflow step

workflow_type

String

Name of the workflow type

workflow

String

Name of the workflow task

workflow_created_at

DateTime

Date and time when the workflow was created

workflow_updated_at

DateTime

Date and time of the last interaction with the workflow

workflow_step_entered

DateTime

Date and time when the current workflow step was entered

deadline_current_workflow_step

DateTime

Deadline for completing the current workflow step

deadline_workflow

DateTime

Overall deadline for completing the workflow

days_in_workflow_step

Numeric

Number of days spent in the current workflow step

days_until_deadline_current_workflow_step

Numeric

Number of days remaining until the current step deadline

days_until_deadline_current_workflow

Numeric

Number of days remaining until the overall workflow deadline

Deprecated Fields

⚠️ Deprecation Notice: The following fields will be deprecated on Wednesday, January 7th, 2025. Please migrate to the recommended alternatives.

Deprecated Field

Type

Recommended Alternative

key_workflow_id

Integer

workflow_id

key_linked_relation_id

Integer

linked_relation_id

key_creator_employee_id

Integer

creator_employee_id

key_responsible_employee_id

Integer

responsible_employee_id

key_linked_project_id

Integer

linked_project_id

key_linked_sales_id

Integer

linked_sales_id

key_workflow_type_id

Integer

workflow_type_id

key_workflow_step_id

Integer

workflow_step_id

description

String

workflow_description

workflow_type_name

String

workflow_type

workflow_task_name

String

workflow

created_at

DateTime

workflow_created_at

updated_at

DateTime

workflow_updated_at

date_in_workflow_step

DateTime

workflow_step_entered

deadline_current_workflow

DateTime

deadline_workflow

Related Tables

  • api_relations - Relation details via linked_relation_id

  • api_employees - Employee details via creator_employee_id or responsible_employee_id

  • api_projects - Project details via linked_project_id

  • api_sales - Sales details via linked_sales_id

Did this answer your question?