Workflow GET API Documentation

Purpose

This API retrieves all milestones associated with a specific workflow instance for a given component and resource (job). It provides complete milestone definitions including scheduling, assignment details, alerts, and pagination metadata, enabling clients to understand the current workflow progress and configuration at a granular level.

Use Case

This endpoint is typically used in workflow-driven applications where users need to view or manage milestones for a specific job or resource. It supports operational dashboards, workflow tracking screens, and automation engines that need visibility into milestone timelines, assignees, and alert configurations for a given workflow instance.

Path Parameters

Parameter	Type	Description
component_uuid	UUID	Unique identifier of the component to which the workflow is attached
component_record_id	String	Identifier of the resource or job associated with the workflow

Query Parameters

Parameter	Type	Description
limit	Integer	Maximum number of milestones to return per page
offset	Integer	Number of records to skip before starting to return results

Request Body

This endpoint does not accept a request body

Response

On successful execution, this API returns a list of milestones configured for the specified workflow and resource. Each milestone includes its identity, status, date range, workflow version reference, assigned users, contacts, and labours, as well as any alerts configured for milestone-based triggers. The response also includes pagination metadata to support incremental data retrieval when the total number of milestones exceeds the page limit.

Response Body

                JSON
              

                      {
  "milestones": [
    {
      "uuid": "MILESTONE_UUID",
      "name": "MILESTONE_NAME",
      "display_name": "MILESTONE_DISPLAY_NAME",
      "description": "MILESTONE_DESCRIPTION",
      "icon": "ICON_URL_OR_EMPTY",
      "status": "STATUS",
      "start_date": "START_DATE_ISO_8601",
      "end_date": "END_DATE_ISO_8601",
      "state_name": "WORKFLOW_STATE_NAME",
      "workflow_version_uuid": "WORKFLOW_VERSION_UUID",
      "assignees": {
        "selected_operators": [
          {
            "uuid": "ASSIGNEE_UUID",
            "name": "NAME",
            "display_name": "DISPLAY_NAME",
            "email": "EMAIL",
            "display_order": INTEGER,
            "user_uuid": "USER_UUID",
            "responsibility_uuid": "RESPONSIBILITY_UUID",
            "responsibility_name": "RESPONSIBILITY_NAME",
            "responsibility_display_name": "RESPONSIBILITY_DISPLAY_NAME"
          }
        ],
        "selected_account_contacts": [
          {
            "uuid": "CONTACT_UUID",
            "name": "NAME",
            "display_name": "DISPLAY_NAME",
            "email": "EMAIL",
            "display_order": INTEGER,
            "account_code": "ACCOUNT_CODE",
            "contact_uuid": "CONTACT_REFERENCE_UUID",
            "responsibility_uuid": "RESPONSIBILITY_UUID",
            "responsibility_name": "RESPONSIBILITY_NAME",
            "responsibility_display_name": "RESPONSIBILITY_DISPLAY_NAME"
          }
        ],
        "selected_labours": [
          {
            "uuid": "LABOUR_UUID",
            "name": "NAME",
            "display_name": "DISPLAY_NAME",
            "email": "EMAIL",
            "display_order": INTEGER,
            "labour_code": "LABOUR_CODE",
            "responsibility_uuid": "RESPONSIBILITY_UUID",
            "responsibility_name": "RESPONSIBILITY_NAME",
            "responsibility_display_name": "RESPONSIBILITY_DISPLAY_NAME"
          }
        ],
        "manually_added_account_contacts": []
      },
      "alerts": [
        {
          "uuid": "ALERT_UUID",
          "name": "ALERT_NAME",
          "display_name": "ALERT_DISPLAY_NAME",
          "description": "ALERT_DESCRIPTION",
          "type": "ALERT_TYPE",
          "trigger_value": INTEGER,
          "trigger_unit": "TIME_UNIT",
          "trigger": "TRIGGER_DIRECTION",
          "trigger_field": "TRIGGER_FIELD",
          "alert_content": "ALERT_CONTENT",
          "status": "STATUS",
          "recipients": [
            {
              "uuid": "RECIPIENT_UUID",
              "display_order": INTEGER,
              "account_code": "ACCOUNT_CODE",
              "user_uuid": "USER_UUID",
              "contact_uuid": "CONTACT_UUID",
              "name": "NAME",
              "display_name": "DISPLAY_NAME",
              "email": "EMAIL"
            }
          ],
          "responsibilities": [],
          "actions": [
            {
              "name": "ACTION_NAME"
            }
          ]
        }
      ],
      "activity_definition_reference_uuid": "ACTIVITY_DEFINITION_UUID"
    }
  ],
  "pagination": {
    "records": TOTAL_RECORDS,
    "limit": LIMIT,
    "offset": OFFSET,
    "previous_page": "PREVIOUS_PAGE_URL",
    "next_page": "NEXT_PAGE_URL"
  }
}

                    

Attribute	Type	Description
milestones	Array	List of milestones associated with the workflow
milestones.uuid	UUID	Unique identifier of the milestone
milestones.name	String	Internal name of the milestone
milestones.display_name	String	Display name of the milestone
milestones.description	String	Description of the milestone
milestones.icon	String	Icon associated with the milestone
milestones.status	String	Current status of the milestone
milestones.start_date	DateTime	Start date of the milestone in ISO 8601 format
milestones.end_date	DateTime	End date of the milestone in ISO 8601 format
milestones.state_name	String	Workflow state associated with the milestone
milestones.workflow_version_uuid	UUID	Identifier of the workflow version
milestones.assignees	Object	Collection of users, contacts, and labours assigned to the milestone
milestones.alerts	Array	Alerts configured for the milestone
milestones.activity_definition_reference_uuid	UUID	Reference to the activity definition linked to the milestone
pagination	Object	Pagination metadata
pagination.records	Integer	Total number of records available
pagination.limit	Integer	Maximum number of records returned
pagination.offset	Integer	Starting index of the current page
pagination.previous_page	String	URL of the previous page
pagination.next_page	String	URL of the next page

Purpose

This API retrieves the complete details of a specific milestone associated with a workflow for a given component and resource (job). It exposes milestone configuration, scheduling information, assignees, alert definitions, and workflow references required to understand and manage the milestone lifecycle.

Use Case

This endpoint is used when a client application needs to display or process detailed information about a single milestone within a workflow. Typical use cases include milestone detail views, workflow execution engines validating milestone assignments and alerts, and administrative tools reviewing milestone configuration for a specific job or resource.

Path Parameters

Parameter	Type	Description
component_uuid	UUID	Unique identifier of the component associated with the workflow
component_record_id	String	Identifier of the resource or job linked to the workflow
milestone_uuid	UUID	Unique identifier of the milestone to be retrieved

Query Parameters

This endpoint does not support query parameters

Request Body

This endpoint does not accept a request body

Response

On successful execution, this API returns a detailed milestone object representing the specified milestone within the workflow. The response includes milestone metadata, scheduling dates, workflow state, assignee information across operators, account contacts, and labours, as well as all configured alerts with their trigger conditions, recipients, and actions. This data enables full visibility into milestone execution requirements and notification behavior.

Response Body

                JSON
              

                      {
  "milestone": {
    "uuid": "MILESTONE_UUID",
    "name": "MILESTONE_NAME",
    "display_name": "MILESTONE_DISPLAY_NAME",
    "description": "MILESTONE_DESCRIPTION",
    "icon": "ICON_URL_OR_EMPTY",
    "status": "STATUS",
    "start_date": "START_DATE_ISO_8601",
    "end_date": "END_DATE_ISO_8601",
    "state_name": "WORKFLOW_STATE_NAME",
    "workflow_version_uuid": "WORKFLOW_VERSION_UUID",
    "assignees": {
      "selected_operators": [
        {
          "uuid": "ASSIGNEE_UUID",
          "name": "NAME",
          "display_name": "DISPLAY_NAME",
          "email": "EMAIL",
          "display_order": INTEGER,
          "user_uuid": "USER_UUID",
          "responsibility_uuid": "RESPONSIBILITY_UUID",
          "responsibility_name": "RESPONSIBILITY_NAME",
          "responsibility_display_name": "RESPONSIBILITY_DISPLAY_NAME"
        }
      ],
      "selected_account_contacts": [
        {
          "uuid": "CONTACT_UUID",
          "name": "NAME",
          "display_name": "DISPLAY_NAME",
          "email": "EMAIL",
          "display_order": INTEGER,
          "account_code": "ACCOUNT_CODE",
          "contact_uuid": "CONTACT_REFERENCE_UUID",
          "responsibility_uuid": "RESPONSIBILITY_UUID",
          "responsibility_name": "RESPONSIBILITY_NAME",
          "responsibility_display_name": "RESPONSIBILITY_DISPLAY_NAME"
        }
      ],
      "selected_labours": [
        {
          "uuid": "LABOUR_UUID",
          "name": "NAME",
          "display_name": "DISPLAY_NAME",
          "email": "EMAIL",
          "display_order": INTEGER,
          "labour_code": "LABOUR_CODE",
          "responsibility_uuid": "RESPONSIBILITY_UUID",
          "responsibility_name": "RESPONSIBILITY_NAME",
          "responsibility_display_name": "RESPONSIBILITY_DISPLAY_NAME"
        }
      ],
      "manually_added_account_contacts": []
    },
    "alerts": [
      {
        "uuid": "ALERT_UUID",
        "name": "ALERT_NAME",
        "display_name": "ALERT_DISPLAY_NAME",
        "description": "ALERT_DESCRIPTION",
        "type": "ALERT_TYPE",
        "trigger_value": INTEGER,
        "trigger_unit": "TIME_UNIT",
        "trigger": "TRIGGER_DIRECTION",
        "trigger_field": "TRIGGER_FIELD",
        "alert_content": "ALERT_CONTENT",
        "status": "STATUS",
        "recipients": [
          {
            "uuid": "RECIPIENT_UUID",
            "display_order": INTEGER,
            "account_code": "ACCOUNT_CODE",
            "user_uuid": "USER_UUID",
            "contact_uuid": "CONTACT_UUID",
            "name": "NAME",
            "display_name": "DISPLAY_NAME",
            "email": "EMAIL"
          }
        ],
        "responsibilities": [],
        "actions": [
          {
            "name": "ACTION_NAME"
          }
        ]
      }
    ],
    "activity_definition_reference_uuid": "ACTIVITY_DEFINITION_UUID"
  }
}

                    

Attribute	Type	Description
milestone	Object	Detailed milestone information
milestone.uuid	UUID	Unique identifier of the milestone
milestone.name	String	Internal name of the milestone
milestone.display_name	String	Display name of the milestone
milestone.description	String	Description of the milestone
milestone.icon	String	Icon associated with the milestone
milestone.status	String	Current status of the milestone
milestone.start_date	DateTime	Start date of the milestone in ISO 8601 format
milestone.end_date	DateTime	End date of the milestone in ISO 8601 format
milestone.state_name	String	Workflow state name associated with the milestone
milestone.workflow_version_uuid	UUID	Identifier of the workflow version
milestone.assignees	Object	Users, contacts, and labours assigned to the milestone
milestone.alerts	Array	Alerts configured for milestone-based triggers
milestone.activity_definition_reference_uuid	UUID	Reference UUID of the linked activity definition

Purpose

This API retrieves the details of a specific alert responsibility configuration using its unique identifier. It allows systems to access responsibility metadata that is used to assign and manage alert ownership within workflows and notification mechanisms.

Use Case

This endpoint is commonly used when an application needs to view or validate alert responsibility details while configuring alerts, assigning responsibilities to workflow milestones, or displaying responsibility information in administrative or configuration screens.

Path Parameters

Parameter	Type	Description
alert_responsibility_uuid	UUID	Unique identifier of the alert responsibility to be retrieved

Query Parameters

This endpoint does not support query parameters

Request Body

This endpoint does not accept a request body

Response

On successful execution, this API returns a single alert responsibility object containing its identifying information, display configuration, current status, and audit timestamps. The response enables client applications to understand how alerts are assigned and managed within the system and to reference this responsibility in alert or workflow configurations.

Response Body

                JSON
              

                      {
  "alert_responsibility": {
    "uuid": "ALERT_RESPONSIBILITY_UUID",
    "name": "RESPONSIBILITY_NAME",
    "display_name": "RESPONSIBILITY_DISPLAY_NAME",
    "description": "RESPONSIBILITY_DESCRIPTION",
    "status": "STATUS",
    "created_on": "CREATED_TIMESTAMP",
    "updated_on": "UPDATED_TIMESTAMP"
  }
}

                    

Attribute	Type	Description
alert_responsibility	Object	Alert responsibility details
alert_responsibility.uuid	UUID	Unique identifier of the alert responsibility
alert_responsibility.name	String	Internal name of the alert responsibility
alert_responsibility.display_name	String	Display name of the alert responsibility
alert_responsibility.description	String	Description of the alert responsibility
alert_responsibility.status	String	Current status of the alert responsibility
alert_responsibility.created_on	DateTime	Timestamp when the alert responsibility was created
alert_responsibility.updated_on	DateTime	Timestamp when the alert responsibility was last updated

Purpose

This endpoint retrieves all workflows configured within a specific instance. It returns both pre‑built system workflows and user‑created workflows, including their metadata such as name, display name, entity, event type, version, status, and timestamps. It is used to view, audit, or manage workflow configurations across modules like Account, Item, Invoice, Payment, Purchase Order, and more.

Use Case

This API is used when administrators, QA teams, or integration systems need to:

Fetch the complete list of workflows available in an instance.
Verify workflow configuration for modules (Account, Item, Invoice, Payment, etc.).
Check workflow status (ACTIVE / INACTIVE).
Retrieve workflow version UUIDs for editing or cloning.
Validate workflow setup during onboarding or automation testing.

It supports workflow dashboards, automation audits, and system configuration tools.

Path Parameters

This endpoint does not require any path parameters.

Query Parameters

Parameter	Type	Description
limit	Integer	Number of workflow records to return per page. Default: 20.
offset	Integer	Number of records to skip before returning results. Used for pagination.

Request Body

This endpoint does not require a request body.

Response

The response returns a list of workflows along with pagination metadata. Each workflow object includes details such as UUID, name, display name, entity, event type (create/update), version UUID, status, timestamps, and creator information. Pagination metadata helps navigate through large workflow sets.

Response Body

                JSON
              

                      {
  "workflows": [
    {
      "created": "CREATED_TIMESTAMP",
      "display_name": "WORKFLOW_DISPLAY_NAME",
      "entity_id": "ENTITY_ID",
      "uuid": "WORKFLOW_UUID",
      "created_by": "CREATED_BY",
      "current_version_uuid": "CURRENT_VERSION_UUID",
      "last_updated_by": "LAST_UPDATED_BY",
      "is_pre_built": "IS_PRE_BUILT",
      "name": "WORKFLOW_NAME",
      "event": "WORKFLOW_EVENT",
      "updated": "UPDATED_TIMESTAMP",
      "entity": "ENTITY_NAME",
      "enable_stage": "ENABLE_STAGE",
      "status": "WORKFLOW_STATUS"
    },
    {
      "created": "CREATED_TIMESTAMP",
      "display_name": "WORKFLOW_DISPLAY_NAME",
      "entity_id": "ENTITY_ID",
      "uuid": "WORKFLOW_UUID",
      "created_by": "CREATED_BY",
      "current_version_uuid": "CURRENT_VERSION_UUID",
      "last_updated_by": "LAST_UPDATED_BY",
      "is_pre_built": "IS_PRE_BUILT",
      "name": "WORKFLOW_NAME",
      "event": "WORKFLOW_EVENT",
      "updated": "UPDATED_TIMESTAMP",
      "entity": "ENTITY_NAME",
      "enable_stage": "ENABLE_STAGE",
      "status": "WORKFLOW_STATUS"
    },
    {
      "created": "CREATED_TIMESTAMP",
      "display_name": "WORKFLOW_DISPLAY_NAME",
      "entity_id": "ENTITY_ID",
      "uuid": "WORKFLOW_UUID",
      "created_by": "CREATED_BY",
      "current_version_uuid": "CURRENT_VERSION_UUID",
      "last_updated_by": "LAST_UPDATED_BY",
      "is_pre_built": "IS_PRE_BUILT",
      "name": "WORKFLOW_NAME",
      "event": "WORKFLOW_EVENT",
      "updated": "UPDATED_TIMESTAMP",
      "entity": "ENTITY_NAME",
      "enable_stage": "ENABLE_STAGE",
      "status": "WORKFLOW_STATUS"
    }
  ],
  "pagination": {
    "records": "TOTAL_RECORDS",
    "limit": "PAGE_LIMIT",
    "offset": "PAGE_OFFSET",
    "previous_page": "PREVIOUS_PAGE_URL",
    "next_page": "NEXT_PAGE_URL"
  }
}

                    

Attribute	Type	Description
workflows	Array	List of workflow objects.
workflows[].uuid	String	Unique identifier of the workflow.
workflows[].name	String	Internal workflow name.
workflows[].display_name	String	User‑friendly workflow name.
workflows[].entity	String	Module/entity the workflow belongs to (e.g., account, item, saleInvoice).
workflows[].event	String	Trigger event: `create` or `update`.
workflows[].status	String	Workflow status: `ACTIVE` or `INACTIVE`.
workflows[].is_pre_built	Boolean / Null	Indicates if workflow is system‑generated.
workflows[].current_version_uuid	String	Version UUID of the workflow.
workflows[].created	DateTime	Workflow creation timestamp.
workflows[].updated	DateTime	Last updated timestamp.
workflows[].created_by	String	Creator of the workflow (System / Implementer).
workflows[].last_updated_by	String / Null	Last user who updated the workflow.
pagination.records	Integer	Total number of workflows.
pagination.limit	Integer	Page size.
pagination.offset	Integer	Current offset.
pagination.previous_page	String	URL for previous page (if any).
pagination.next_page	String	URL for next page (if any).

Purpose

This endpoint retrieves all states of a specific workflow along with the milestones configured under each state. It provides a complete structural view of the workflow, including Begin/End states and intermediate states that contain one or more milestones.

Use Case

This API is used when users or systems need to load the full workflow structure, including states and their milestones. It supports workflow editors, automation validation, and UI rendering of the State Settings panel. It is also used to verify milestone configuration such as priority, auto‑create behavior, and status during workflow setup, debugging, or testing.

Path Parameters

Parameter	Type	Description
workflow_uuid	uuid	Workflow UUID whose states and milestones need to be retrieved.

Query Parameters

Parameter	Type	Description
limit	Integer	Number of state records to return per page. Default: 20.
offset	Integer	Number of records to skip before returning results.

Request Body

This endpoint does not require a request body.

Response

The endpoint response returns a list of workflow states, each containing metadata such as UUID, name, display name, workflow version, and status. Each state includes a milestones array, which lists all milestones configured under that state. Milestone details include UUID, name, display name, priority, estimated hours, auto‑create flag, and status. Pagination metadata is also included to support navigation across large workflow structures.

Response Body

                JSON
              

                      {
  "states": [
    {
      "workflow_version_uuid": "WORKFLOW_VERSION_UUID",
      "name": "STATE_NAME",
      "workflow_uuid": "WORKFLOW_UUID",
      "display_name": "STATE_DISPLAY_NAME",
      "milestones": [],
      "uuid": "STATE_UUID",
      "status": "STATE_STATUS"
    },
    {
      "workflow_version_uuid": "WORKFLOW_VERSION_UUID",
      "name": "STATE_NAME",
      "workflow_uuid": "WORKFLOW_UUID",
      "display_name": "STATE_DISPLAY_NAME",
      "milestones": [],
      "uuid": "STATE_UUID",
      "status": "STATE_STATUS"
    },
    {
      "workflow_version_uuid": "WORKFLOW_VERSION_UUID",
      "name": "STATE_NAME",
      "workflow_uuid": "WORKFLOW_UUID",
      "display_name": "STATE_DISPLAY_NAME",
      "milestones": [
        {
          "workflow_version_uuid": "WORKFLOW_VERSION_UUID",
          "name": "MILESTONE_NAME",
          "estimated_hours": "ESTIMATED_HOURS",
          "state_uuid": "STATE_UUID",
          "priority": "MILESTONE_PRIORITY",
          "display_name": "MILESTONE_DISPLAY_NAME",
          "uuid": "MILESTONE_UUID",
          "auto_create": "AUTO_CREATE",
          "status": "MILESTONE_STATUS"
        }
      ],
      "uuid": "STATE_UUID",
      "status": "STATE_STATUS"
    },
    {
      "workflow_version_uuid": "WORKFLOW_VERSION_UUID",
      "name": "STATE_NAME",
      "workflow_uuid": "WORKFLOW_UUID",
      "display_name": "STATE_DISPLAY_NAME",
      "milestones": [
        {
          "workflow_version_uuid": "WORKFLOW_VERSION_UUID",
          "name": "MILESTONE_NAME",
          "estimated_hours": "ESTIMATED_HOURS",
          "state_uuid": "STATE_UUID",
          "priority": "MILESTONE_PRIORITY",
          "display_name": "MILESTONE_DISPLAY_NAME",
          "uuid": "MILESTONE_UUID",
          "auto_create": "AUTO_CREATE",
          "status": "MILESTONE_STATUS"
        },
        {
          "workflow_version_uuid": "WORKFLOW_VERSION_UUID",
          "name": "MILESTONE_NAME",
          "estimated_hours": "ESTIMATED_HOURS",
          "state_uuid": "STATE_UUID",
          "priority": "MILESTONE_PRIORITY",
          "display_name": "MILESTONE_DISPLAY_NAME",
          "uuid": "MILESTONE_UUID",
          "auto_create": "AUTO_CREATE",
          "status": "MILESTONE_STATUS"
        }
      ],
      "uuid": "STATE_UUID",
      "status": "STATE_STATUS"
    }
  ],
  "pagination": {
    "records": "TOTAL_RECORDS",
    "limit": "PAGE_LIMIT",
    "offset": "PAGE_OFFSET",
    "previous_page": "PREVIOUS_PAGE_URL",
    "next_page": "NEXT_PAGE_URL"
  }
}

                    

Attribute	Type	Description
states	Array	List of workflow states.
uuid	String	Unique identifier of the state.
name	String	Internal state name (e.g., Begin, End, State_1).
display_name	String	User‑friendly state name.
workflow_uuid	String	Workflow UUID this state belongs to.
workflow_version_uuid	String	Workflow version UUID.
status	String	State status (ACTIVE / INACTIVE).
milestones	Array	List of milestones under the state.
uuid	String	Unique identifier of the milestone.
name	String	Internal milestone name.
display_name	String	User‑friendly milestone name.
priority	String	Priority (LOW, MEDIUM, HIGH, CRITICAL).
estimated_hours	String / Null	Estimated hours to complete.
auto_create	Boolean	Whether milestone auto‑creates tasks.
status	String	Milestone status (ACTIVE / INACTIVE).
state_uuid	String	State UUID this milestone belongs to.
workflow_version_uuid	String	Workflow version UUID.
records	Integer	Total number of states.
limit	Integer	Page size.
offset	Integer	Current offset.
previous_page	String	URL for previous page (if any).
next_page	String	URL for next page (if any).

Purpose

This endpoint retrieves the complete workflow history of a specific component record. When a component has an active workflow and a new object is created or updated, the workflow runs through its configured states. This API returns the chronological list of state transitions, showing how the workflow progressed from Begin → intermediate states → End. It is essential for workflow monitoring, debugging, automation tracking, and audit logs.

Use Case

This API is used when users or systems need to view the state transition history of a workflow instance tied to a specific component object. It helps administrators and QA teams verify whether the workflow executed correctly, identify where it may have stopped, and confirm transitions triggered by system automation or user actions. It is also used in workflow dashboards, audit trails, and workflow debugging tools to visualize the exact path taken by the workflow.

Path Parameters

Parameter	Type	Required	Description
object_id	String	Yes	The component object ID whose workflow history needs to be retrieved.

Query Parameters

Parameter	Type	Description
limit	Integer	Number of history records to return per page. Default: 20.
offset	Integer	Number of records to skip before returning results.

Request Body

This endpoint does not require a request body.

Response

The response returns a list of workflow history entries, each representing a transition from one state to another. Each history record includes the originating state, destination state, timestamp, workflow version, and the user or system responsible for the transition. This provides a complete audit trail of how the workflow executed for the given component object. Pagination metadata is included to support navigation through long workflow histories.

Response Body

                JSON
              

                      {
  "pagination": {
    "records": "TOTAL_RECORDS",
    "limit": "PAGE_LIMIT",
    "offset": "PAGE_OFFSET",
    "previous_page": "PREVIOUS_PAGE_URL",
    "next_page": "NEXT_PAGE_URL"
  },
  "histories": [
    {
      "from_state": "FROM_STATE",
      "note": "NOTE",
      "created_on": "CREATED_TIMESTAMP",
      "workflow_version_uuid": "WORKFLOW_VERSION_UUID",
      "changed_by": "CHANGED_BY",
      "uuid": "HISTORY_UUID",
      "to_state": "TO_STATE"
    },
    {
      "from_state": "FROM_STATE",
      "note": "NOTE",
      "created_on": "CREATED_TIMESTAMP",
      "workflow_version_uuid": "WORKFLOW_VERSION_UUID",
      "changed_by": "CHANGED_BY",
      "uuid": "HISTORY_UUID",
      "to_state": "TO_STATE"
    },
    {
      "from_state": "FROM_STATE",
      "note": "NOTE",
      "created_on": "CREATED_TIMESTAMP",
      "workflow_version_uuid": "WORKFLOW_VERSION_UUID",
      "changed_by": "CHANGED_BY",
      "uuid": "HISTORY_UUID",
      "to_state": "TO_STATE"
    },
    {
      "from_state": "FROM_STATE",
      "note": "NOTE",
      "created_on": "CREATED_TIMESTAMP",
      "workflow_version_uuid": "WORKFLOW_VERSION_UUID",
      "changed_by": "CHANGED_BY",
      "uuid": "HISTORY_UUID",
      "to_state": "TO_STATE"
    }
  ]
}

                    

Attribute	Type	Description
histories	Array	List of workflow history entries.
uuid	String	Unique identifier of the history record.
from_state	String / Null	The state from which the workflow transitioned (null for the first entry).
to_state	String	The state to which the workflow transitioned.
note	String / Null	Optional note added during the transition.
created_on	DateTime	Timestamp when the transition occurred.
changed_by	String	User or system that triggered the transition.
workflow_version_uuid	String	Workflow version associated with the transition.
records	Integer	Total number of history records.
limit	Integer	Page size.
offset	Integer	Current offset.
previous_page	String	URL for previous page (if any).
next_page	String	URL for next page (if any).

Retrieve All Milestones of a Specific Workflow (Resource / Job Specific): /workflow/component/{component_uuid}/{resource_id}/milestone

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Milestone Details of a Specific Workflow (Resource / Job Specific): /workflow/component/{component_uuid}/{resource_id}/milestone/{milestone_uuid}

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Alert Responsibility Details: /alert_responsibility/{alert_responsibility_uuid}

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve All Workflows : /settings/workflows

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Milestones of Workflow States: /workflows/{workflow_uuid}/states/milestones

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Workflow History : /workflow/component/{object_id}/history

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Looking to build your next big project?