List workflow 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
If specified, the operation retrieves the task that is with specified id.
If specified, the operation retrieves tasks that is in the specified name.
If set to true, the operation retrieves workflows that have the scheduled trigger enabled. If set to false, the operation retrieves workflows that have the scheduled trigger disabled. If not specfied, the operation will not use this filter.
If specified, the operation retrieves tasks that is the specified type.
If specified, the operation retrieves tasks with the specified object.
If specified, the operation retrieves tasks with the specified object id.
If specified, the operation retrieves tasks with the specified api call type used.
If specified, the operation retrieves tasks that for the specified workflow id.
If specified, the operation retrieves tasks that with the specified filter tags. Use the following syntax to specify multiple tags: tags[]=tag_value_1&tags[]=tag_value_2.
Note: All the workflow tasks that have any of the specified tags will be listed in the response body.
If you want to retrieve only the workflows on a specific page, you can specify the page number in the query.
The number of workflow tasks shown in a single call. If the page parameter is not specified, the operation will return only the first page of results. If there are multiple pages of results, use it with the page parameter to get the results on subsequent pages. The maximum value is 100.
Headers
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.
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.
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.
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.
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