Task GET API Documentation

Purpose

This endpoint retrieves a paginated list of tasks created in the Exsited system. Tasks are independent components meaning they can be created directly as standalone records. Tasks may also be auto‑generated through Workflow → State → Milestone → Task configurations. When a workflow is created for a custom component and the Task has Auto Create enabled, the system automatically generates tasks for that component. This endpoint provides full visibility into all tasks, including their status, priority, scheduling details, assignees, and checklist items.

Use Case

This endpoint is used when users or systems need to retrieve all tasks created within Exsited, whether they were created manually or auto‑generated through workflows. It supports dashboards, reporting, workflow monitoring, and operational tracking. Developers and QA teams use this API to validate task creation, verify workflow auto‑creation behavior, and ensure that task metadata such as priority, dates, assignees, and checklists are correctly stored and returned.

Path Parameters

This endpoint does not require any path parameters.

Query Parameters

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

Request Body

This API does not require a request body.

Response

The endpoint returns successfully a tasks array containing multiple task records. Each task includes metadata such as UUID, code, status, task status, name, display name, priority, scheduling details, estimated and actual hours, and timestamps. It also includes nested structures such as assignees (operators, account contacts, labours, employees), checklist items, and alerts. Pagination metadata is included to support navigation across large datasets. This structure ensures complete visibility into all tasks created in the system, regardless of whether they originate from workflows or standalone creation.

Response Body

                JSON
              

                      {
  "tasks": [
    {
      "uuid": "TASK_UUID",
      "code": "TASK_CODE",
      "status": "TASK_STATUS",
      "task_status": "TASK_PROGRESS_STATUS",
      "name": "TASK_NAME",
      "display_name": "TASK_DISPLAY_NAME",
      "description": "TASK_DESCRIPTION",
      "priority": "TASK_PRIORITY",
      "sort_order": "TASK_SORT_ORDER",
      "estimated_hours": "ESTIMATED_HOURS",
      "actual_hours": "ACTUAL_HOURS",
      "start_date": "START_DATE",
      "due_date": "DUE_DATE",
      "completed_at": "COMPLETED_AT",
      "completed_by": "COMPLETED_BY",
      "created_on": "CREATED_TIMESTAMP",
      "checklist": "CHECKLIST",
      "assignees": {
        "selected_operators": "SELECTED_OPERATORS",
        "selected_account_contacts": "SELECTED_ACCOUNT_CONTACTS",
        "selected_labours": "SELECTED_LABOURS",
        "selected_employees": "SELECTED_EMPLOYEES",
        "manually_added_account_contacts": "MANUALLY_ADDED_ACCOUNT_CONTACTS"
      },
      "alerts": "ALERTS",
      "parent_organization": "PARENT_ORGANIZATION",
      "created_by": "CREATED_BY",
      "last_updated_by": "LAST_UPDATED_BY",
      "last_updated_on": "LAST_UPDATED_TIMESTAMP",
      "version": "TASK_VERSION"
    }
  ],
  "pagination": {
    "records": "TOTAL_RECORDS",
    "limit": "PAGE_LIMIT",
    "offset": "PAGE_OFFSET",
    "previous_page": "PREVIOUS_PAGE_URL",
    "next_page": "NEXT_PAGE_URL"
  }
}

                    

Attribute	Type	Description
uuid	String	Unique identifier of the task.
code	String	System‑generated task code.
status	String	ACTIVE / INACTIVE.
task_status	String	IN_PROGRESS, COMPLETED, etc.
name	String	Internal name of the task.
display_name	String	User‑friendly name.
description	String	Optional description.
priority	String	Task priority (LOW, MEDIUM, HIGH, CRITICAL).
sort_order	String	Order of the task under a milestone.
estimated_hours	String	Estimated time to complete.
actual_hours	String	Actual time spent.
start_date	DateTime	Task start date.
due_date	DateTime	Task due date.
completed_at	DateTime	Completion timestamp.
completed_by	String	User who completed the task.
created_on	DateTime	Creation timestamp.
created_by	String	Creator of the task.
last_updated_by	String	Last user who updated the task.
last_updated_on	DateTime	Last update timestamp.
version	String	Version number.
checklist	Array	List of checklist items.
assignees	Object	Contains selected operators, account contacts, labours, employees.
alerts	Array	Alerts configured for the task.
parent_organization	String	Organization ID.
pagination	Object	Pagination metadata.

Purpose

This API retrieves the full details of a specific task using its unique identifier. Tasks in Exsited can be created independently or auto‑generated through Workflow → State → Milestone → Task. This endpoint provides complete visibility into a task’s metadata, including status, scheduling, priority, assignees, checklist, and audit information. It is used whenever a system or user needs to view the complete details of a single task record.

Use Case

This endpoint is used when a user or system needs to fetch the full details of a specific task for display, editing, workflow processing, or auditing. It is commonly used in task dashboards, workflow execution screens, and automation processes where the system must validate the current task status, assigned users, due dates, or checklist progress. It also helps QA teams verify that tasks created manually or through workflows store and return accurate data.

Path Parameters

Parameter	Type	Description
account_id	String	Unique identifier of the task to retrieve.

Query Parameters

This endpoint does not support query parameters.

Request Body

This API does not require a request body.

Response

The endpoint returns succesfully a task object containing all details of the requested task. The response includes core attributes such as name, display name, priority, status, and task status. It also provides scheduling information like start date, due date, and completion timestamps. Nested structures include assignees (operators, account contacts, labours, employees), checklist items, and alerts. Audit metadata such as created_by, created_on, last_updated_by, and version ensures full traceability. This structure provides a complete representation of the task for UI rendering, workflow processing, or system integrations.

Response Body

                JSON
              

                      {
  "task": {
    "uuid": "TASK_UUID",
    "code": "TASK_CODE",
    "status": "TASK_STATUS",
    "task_status": "TASK_PROGRESS_STATUS",
    "name": "TASK_NAME",
    "display_name": "TASK_DISPLAY_NAME",
    "description": "TASK_DESCRIPTION",
    "priority": "TASK_PRIORITY",
    "sort_order": "TASK_SORT_ORDER",
    "estimated_hours": "ESTIMATED_HOURS",
    "actual_hours": "ACTUAL_HOURS",
    "start_date": "START_DATE",
    "due_date": "DUE_DATE",
    "completed_at": "COMPLETED_AT",
    "completed_by": "COMPLETED_BY",
    "created_on": "CREATED_TIMESTAMP",
    "checklist": "CHECKLIST",
    "assignees": {
      "selected_operators": "SELECTED_OPERATORS",
      "selected_account_contacts": "SELECTED_ACCOUNT_CONTACTS",
      "selected_labours": "SELECTED_LABOURS",
      "selected_employees": "SELECTED_EMPLOYEES",
      "manually_added_account_contacts": "MANUALLY_ADDED_ACCOUNT_CONTACTS"
    },
    "alerts": "ALERTS",
    "parent_organization": "PARENT_ORGANIZATION",
    "created_by": "CREATED_BY",
    "last_updated_by": "LAST_UPDATED_BY",
    "last_updated_on": "LAST_UPDATED_TIMESTAMP",
    "version": "TASK_VERSION"
  }
}

                    

Attribute	Type	Description
uuid	String	Unique identifier of the task.
code	String	System‑generated task code.
status	String	ACTIVE / INACTIVE.
task_status	String	Current progress status (e.g., IN_PROGRESS, COMPLETED).
name	String	Internal name of the task.
display_name	String	User‑friendly name.
description	String	Optional description.
priority	String	Task priority (LOW, MEDIUM, HIGH, CRITICAL).
sort_order	String	Order of the task under a milestone.
estimated_hours	String	Estimated time to complete.
actual_hours	String	Actual time spent.
start_date	DateTime	Task start date.
due_date	DateTime	Task due date.
completed_at	DateTime	Completion timestamp.
completed_by	String	User who completed the task.
created_on	DateTime	Creation timestamp.
created_by	String	Creator of the task.
last_updated_by	String	Last user who updated the task.
last_updated_on	DateTime	Last update timestamp.
version	String	Version number.
checklist	Array	List of checklist items.
assignees	Object	Contains selected operators, account contacts, labours, employees, and manually added contacts.
alerts	Array	Alerts configured for the task.
parent_organization	String	Organization ID.

Purpose

This endpoint retrieves all checklist items associated with a specific task. In Exsited, a task may contain multiple checklist items that represent smaller actionable steps required to complete the task. This endpoint provides full visibility into each checklist item, including its status, order, description, and completion details.

Use Case

This endpoint is used when users or systems need to view all checklist items under a specific task. It is commonly used in workflow execution screens, task detail pages, and progress‑tracking dashboards. QA teams also use this endpoint to validate that checklist items created through the UI or workflow automation are correctly stored and returned. Since checklist items may be completed individually, this API helps track which steps are pending or completed.

Path Parameters

No path parameters required for this endpoint.

Query Parameters

Parameter	Type	Description
limit	Integer	Number of checklist items to return per page.
offset	Integer	Pagination offset for retrieving the next set of checklist items.

Request Body

This API does not require a request body.

Response

The endpoint successfully returns a task object containing a checklist array. Each checklist item includes its UUID, name, display name, description, status (key/value), sort order, and completion metadata. Pagination details are also included to support navigation when a task contains many checklist items. This structure ensures complete visibility into the task’s step‑by‑step requirements and progress.

Response Body

                JSON
              

                      {
  "task": {
    "checklist": [
      {
        "uuid": "CHECKLIST_UUID",
        "name": "CHECKLIST_NAME",
        "display_name": "CHECKLIST_DISPLAY_NAME",
        "description": "CHECKLIST_DESCRIPTION",
        "status": {
          "key": "CHECKLIST_STATUS_KEY",
          "value": "CHECKLIST_STATUS_VALUE"
        },
        "sort_order": "CHECKLIST_SORT_ORDER",
        "completed_at": "CHECKLIST_COMPLETED_AT",
        "completed_by": "CHECKLIST_COMPLETED_BY"
      },
      {
        "uuid": "CHECKLIST_UUID",
        "name": "CHECKLIST_NAME",
        "display_name": "CHECKLIST_DISPLAY_NAME",
        "description": "CHECKLIST_DESCRIPTION",
        "status": {
          "key": "CHECKLIST_STATUS_KEY",
          "value": "CHECKLIST_STATUS_VALUE"
        },
        "sort_order": "CHECKLIST_SORT_ORDER",
        "completed_at": "CHECKLIST_COMPLETED_AT",
        "completed_by": "CHECKLIST_COMPLETED_BY"
      }
    ],
    "pagination": {
      "records": "TOTAL_RECORDS",
      "limit": "PAGE_LIMIT",
      "offset": "PAGE_OFFSET",
      "previous_page": "PREVIOUS_PAGE_URL",
      "next_page": "NEXT_PAGE_URL"
    }
  }
}

                    

Attribute	Type	Description
uuid	String	Unique identifier of the checklist item.
name	String	Internal name of the checklist item.
display_name	String	User‑friendly name.
description	String	Description of the checklist action.
status.key	String	Status code (e.g., PENDING, COMPLETED).
status.value	String	Human‑readable status label.
sort_order	Integer	Order of the checklist item within the task.
completed_at	DateTime	Timestamp when the item was completed.
completed_by	String	User who completed the item.
pagination.records	Integer	Total number of checklist items.
pagination.limit	Integer	Number of items returned per page.
pagination.offset	Integer	Current offset.
pagination.previous_page	String	URL for the previous page.
pagination.next_page	String	URL for the next page.

Retrieve Multiple Tasks: /tasks

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve a Single Task: /tasks/{task_id}

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Checklist of a Task: /tasks/{task_id}/checklist

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Looking to build your next big project?