---
title: "Get a list of Tasks"
method: POST
path: "/tasks/list"
tags: ["tasks"]
---

# Get a list of Tasks

`POST /tasks/list`

This operation gets a list of Tasks, allowing for sorting and pagination. Note: Entities that have not been created successfully are not listed.

## Request body

- TaskListMetadata — All api calls that return a list will have this metadata block as input
  - `filter` string — The filter in FIQL syntax used for the results.
  - `kind` string — The kind name
  - `sort_order` string — The sort order in which results are returned
  - `offset` integer — Offset from the start of the entity list
  - `length` integer — The number of records to retrieve relative to the offset
  - `sort_attribute` string — The attribute to perform sort on

## Response `200`

Success

- TaskListIntentResponse — Task entity list.
  - `entities` Task[], required
    - `status` string — Task status
    - `last_update_time` string, date-time — UTC date and time in RFC-3339 format when task was last updated
    - `logical_timestamp` integer — The logical timestamp
    - `start_time` string, date-time — UTC date and time in RFC-3339 format when Task execution started
    - `creation_time` string, date-time — UTC date and time in RFC-3339 format when task was created
    - `completion_time` string, date-time — UTC date and time in RFC-3339 format when Task execution completed
    - `percentage_complete` integer — The completion percentage for the task
    - `parent_task_reference` TaskReference — The reference to a task
      - `kind` string, required — The kind name
      - `name` string
      - `uuid` string, UUID, required
    - `error_detail` string — In case of task failure this field will provide the error description
    - `uuid` string, UUID — UUID of the task.
    - `entity_reference_list` Reference[]
      - `kind` string, required
      - `uuid` string, UUID, required
      - `name` string
    - `subtask_reference_list` TaskReference[] — Reference to the sub-tasks
      - `kind` string, required — The kind name
      - `name` string
      - `uuid` string, UUID, required
    - `progress_message` string — Description of what currently the task is doing
    - `operation_type` string — Type of the operation tracked by the task
    - `error_code` string — In case of task failure this field will provide the error code
    - `cluster_reference` ClusterReference — The reference to a cluster
      - `kind` string, required — The kind name
      - `name` string
      - `uuid` string, UUID, required
    - `api_version` string — API version
  - `api_version` string, required
  - `metadata` TaskListMetadataOutput, required — All api calls that return a list will have this metadata block
    - `filter` string — The filter used for the results
    - `kind` string — The kind name
    - `sort_order` string — The sort order in which results are returned
    - `offset` integer — Offset from the start of the entity list
    - `total_matches` integer — Total matches found
    - `length` integer — The number of records retrieved relative to the offset
    - `sort_attribute` string — The attribute to perform sort on

## Other responses

- `default` — Internal Error

---

[API](https://skmtc.net/nutanix/apis/nutanix-intentful-api.md) · [All operations](https://skmtc.net/nutanix/apis/nutanix-intentful-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nutanix/nutanix-intentful-api/revisions/40395083ab31/schema)