---
title: "List tasks"
method: GET
path: "/tasks"
tags: ["Task"]
---

# List tasks

`GET /tasks`

This endpoint allows you to filter [VTEX DO](https://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu) tasks. You can choose between the following filtering options:

- **Assignees:** using `assignee.email` and `status`. Example: `https://{{accountName}}.{{environment}}.com.br/api/do/tasks?assignee.email={{person@email.com}}&status={{open}}`. 

- **Targets:** using `targetId` and `status`. Example: `https://{{accountName}}.{{environment}}.com.br/api/do/tasks?target.id={{name}}&status={{open}}`. 

- **Paged tasks:** using `page`, `perPage` and `status`. Example: `https://{{accountName}}.{{environment}}.com.br/api/do/tasks?page={{1}}&perPage={{10}}&status=;{{-Closed}}`. 

- **Context:** using `context`, `page`, `perPage` and `status`. Example: `https://{{accountName}}.{{environment}}.com.br/api/do/tasks?context={{context}}&page={{1}}&perPage={{10}}&status={{-Closed}}`.

## Permissions

This endpoint does not require [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).

## Query parameters

- `assignee.email` string
- `target.id` string
- `context` string
- `page` string
- `perPage` string
- `status` string

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Response `200`

OK

- object
  - `piiHidden` boolean — If the VTEX account uses [PII data architecture](https://developers.vtex.com/docs/guides/pii-data-architecture-specifications) (`true`), or not (`false`).
  - `items` object[] — Task items array.
    - `comments` string[], nullable — Task item comments list.
    - `id` string, nullable — Task item ID.
    - `surrogateKey` string — [Surrogate key](https://www.ibm.com/docs/en/ida/9.1?topic=keys-surrogate) unique identifier of the task item.
    - `domain` string — Task item domain in the VTEX environment.
    - `target` object[] — Task item target array.
      - `id` string — Task item target ID.
      - `type` string — Task item target type.
      - `url` string — Task item target URL.
    - `name` string — Task item name.
    - `translateMapping` object — Task item translate mapping.
      - `ar` string — Task item Arabic translation.
      - `bg` string — Task item Bulgarian translation.
      - `en` string — Task item English translation.
      - `es` string — Task item Spanish translation.
      - `fr` string — Task item French translation.
      - `it` string — Task item Italian translation.
      - `ja` string — Task item Japanese translation.
      - `ko` string — Task item Korean translation.
      - `nl` string — Task item Dutch translation.
      - `pt` string — Task item Portuguese translation.
      - `ro` string — Task item Romanian translation.
      - `th` string — Task item Thai translation.
    - `context` string — Task item context.
    - `priority` string — Task item level of priority.
    - `status` string — Task item status.
    - `creationDate` string — Task item creation date and time in in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DD hh:mm:ss[.nnnnnnn]Z`.
    - `assignee` object, nullable — Task item assignee.
      - `id` string, nullable — Task item assignee ID.
      - `name` string — Task item assignee name.
      - `email` string — Task item assignee email.
      - `key` string, nullable — Task item assignee key.
  - `paging` object — Object with information about pagination.
    - `page` integer — Task item page number.
    - `perPage` integer — Task items per page.
    - `total` integer — Total task items.
    - `pages` integer — Total task pages.

## Changes

> 53 revisions in range; 18 could not be searched.

- **2024-06-21** `a297dc0d5d17` — 1 breaking, 3 warning
  - the response's body type/format changed from `object`/`` to ``/`` for status `200`
  - removed the optional property `items` from the response with the `200` status
  - removed the optional property `paging` from the response with the `200` status
  - removed the optional property `piiHidden` from the response with the `200` status

[Change history](https://skmtc.dev/vtex/apis/vtex-do-api/changes/tasks/get.md)

---

[API](https://skmtc.dev/vtex/apis/vtex-do-api.md) · [All operations](https://skmtc.dev/vtex/apis/vtex-do-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vtex/vtex-do-api/revisions/606bdad07f53/schema)