Skip to main content

api_workflows

⚠️ 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.

This table provides workflow/task data from Simplicate.

Description

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

Fields

Field NameTypeDescription
workflow_idIntegerUnique identifier for the workflow
linked_relation_idIntegerIdentifier of the linked relation (customer/contact)
creator_employee_idIntegerIdentifier of the employee who created the workflow
responsible_employee_idIntegerIdentifier of the employee responsible for the current workflow step
linked_project_idIntegerIdentifier of the linked project (if applicable)
linked_sales_idIntegerIdentifier of the linked sale (if applicable)
workflow_type_idIntegerIdentifier of the workflow type
workflow_step_idIntegerIdentifier of the current workflow step
workflow_descriptionStringName or description of the workflow
workflow_stepStringName of the current workflow step
workflow_typeStringName of the workflow type
workflowStringName of the workflow task
workflow_created_atDateTimeDate and time when the workflow was created
workflow_updated_atDateTimeDate and time of the last interaction with the workflow
workflow_step_enteredDateTimeDate and time when the current workflow step was entered
deadline_current_workflow_stepDateTimeDeadline for completing the current workflow step
deadline_workflowDateTimeOverall deadline for completing the workflow
days_in_workflow_stepNumericNumber of days spent in the current workflow step
days_until_deadline_current_workflow_stepNumericNumber of days remaining until the current step deadline
days_until_deadline_current_workflowNumericNumber 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 FieldTypeRecommended Alternative
key_workflow_idIntegerworkflow_id
key_linked_relation_idIntegerlinked_relation_id
key_creator_employee_idIntegercreator_employee_id
key_responsible_employee_idIntegerresponsible_employee_id
key_linked_project_idIntegerlinked_project_id
key_linked_sales_idIntegerlinked_sales_id
key_workflow_type_idIntegerworkflow_type_id
key_workflow_step_idIntegerworkflow_step_id
descriptionStringworkflow_description
workflow_type_nameStringworkflow_type
workflow_task_nameStringworkflow
created_atDateTimeworkflow_created_at
updated_atDateTimeworkflow_updated_at
date_in_workflow_stepDateTimeworkflow_step_entered
deadline_current_workflowDateTimedeadline_workflow
  • 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