Sign in
Workflows

Retrieve a workflow task

Retrieves a specific workflow task by its ID.

User Access Permission

You must be assigned the Workflow View Access permission to run this operation.

get/workflows/tasks/{task_id}

Path parameters

task_idstring required

The unique ID of the task.

Headers

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Response

OK

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_typestring

The type of API used.

concurrent_limitinteger

the number of concurrent tasks that are allowed to run simultaneously

dataobject

The data payload for the task.

end_timestring

If Instance is true, the end time of the task instance.

errorstring nullable

If Instance is true and status is Error, the error reason of the task instance failure.

error_classstring nullable

If Instance is true and status is Error, the error class of the task instance failure.

error_detailsstring nullable

If Instance is true and status is Error, the error details of the task instance failure.

idinteger

The unique ID of the task.

instanceboolean

Indicates whether this task belongs to an instance of a workflow.

namestring

The name of the task.

objectstring nullable

The selected object for the task.

object_idstring nullable

The id of the selected object of the task.

original_task_idinteger nullable

If Instance is true, the ID of the original task in the original workflow.

original_workflow_idinteger nullable

If Instance is true, the ID of the original workflow.

parametersobject

The configuration of the task.

start_timestring

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.

tagsstring[]

The array of filter tags.

task_idinteger nullable

the id of this task's parent task. Will be null if this is the first task of the workflow

workflow_idinteger

The ID of the workflow that the task belongs to.

Changes