---
title: "List workflow tasks"
method: GET
path: "/workflows/tasks"
tags: ["Workflows"]
---

# List workflow tasks

`GET /workflows/tasks`

Retrieves a list of workflow tasks available in your Zuora tenant.

### User Access Permission
You must be assigned the **Workflow View Access** permission to run this operation.

## Query parameters

- `id` string
- `name` string
- `instance` boolean
- `action_type` string
- `object` string
- `object_id` string
- `call_type` string
- `workflow_id` string
- `tags` string[]
- `page` integer
- `page_length` integer

## Headers

- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Track-Id` string

## Response `200`

OK

- TasksResponse
  - `data` Task[] — The list of tasks retrieved.
    - `action_type` 'Approval' | 'Attachment' | 'Billing::BillRun' | 'Billing::CurrencyConversion' | 'Billing::CustomInvoice' | 'Callout' | 'Cancel' | 'Create' | 'CustomObject::Create' | 'CustomObject::Delete' | 'CustomObject::Query' | 'CustomObject::Update' | 'Data::BillingPreviewRun' | 'Data::Link' | 'Delay' | 'Delete' | 'Download::SFTP' | 'Email' | 'Export' | 'File::CustomPDF::CustomDocument' | 'If' | 'InvoiceGenerate' | 'Iterate' | 'Logic::CSVTranslator' | 'Logic::Case' | 'Logic::CustomCode' | 'Logic::JSONTransform' | 'Logic::Lambda' | 'Logic::ResponseFormatter' | 'Logic::XMLTransform' | 'NewProduct' | 'Notifications::GoogleCloudPrint' | 'Notifications::PhoneCall' | 'Notifications::SMS' | 'Payment::GatewayReconciliation' | 'Payment::PaymentRun' | 'Query' | 'RemoveProduct' | 'Reporting::ReportData' | 'Reporting::RunReport' | 'Resume' | 'Suspend' | 'UI::Page' | 'UI::Stop' | 'Update' | 'Upload::FTP' | 'Upload::SFTP' | 'WriteOff' — The type of the task.
    - `call_type` string — The type of API used.
    - `concurrent_limit` integer — the number of concurrent tasks that are allowed to run simultaneously
    - `data` object — The data payload for the task.
    - `end_time` string — If **Instance** is **true**, the end time of the task instance.
    - `error` string, nullable — If **Instance** is **true** and **status** is **Error**, the error reason of the task instance failure.
    - `error_class` string, nullable — If **Instance** is **true** and **status** is **Error**, the error class of the task instance failure.
    - `error_details` string, nullable — If **Instance** is **true** and **status** is **Error**, the error details of the task instance failure.
    - `id` integer — The unique ID of the task.
    - `instance` boolean — Indicates whether this task belongs to an instance of a workflow.
    - `name` string — The name of the task.
    - `object` string, nullable — The selected object for the task.
    - `object_id` string, nullable — The id of the selected object of the task.
    - `original_task_id` integer, nullable — If **Instance** is **true**, the ID of the original task in the original workflow.
    - `original_workflow_id` integer, nullable — If **Instance** is **true**, the ID of the original workflow.
    - `parameters` object — The configuration of the task.
    - `start_time` string — If **Instance** is **true**, the start time of the task instance.
    - `status` 'Queued' | 'Processing' | 'Pending' | 'Success' | 'Stopped' | 'Error', nullable — If **Instance** is **true**, the status of the task instance.
    - `tags` string[] — The array of filter tags.
    - `task_id` integer, nullable — the id of this task's parent task. Will be null if this is the first task of the workflow
    - `workflow_id` integer — The ID of the workflow that the task belongs to.
  - `pagination` object — An object containing pagination information for the list of tasks returned by the API.
    - `next_page` string — A string containing the URL where the next page of data can be retrieved.
    - `page` integer, nullable — An integer denoting the current page number.
    - `page_length` integer, nullable — An integer denoting the number of tasks in this response. The maximum value is 100.

---

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