Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuora Workflows API

A workflow is a sequence of tasks that are performed based on predefined logic. A workflow improves efficiency and reduces errors by automating a series of complex tasks that otherwise need to be performed manually and repetitively.For more information, see Workflow.

Zuora Workflows API is one of 80 APIs that Zuora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workflows. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 16 operations across 14 paths, and defines 23 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.

16 operations 14 paths 23 schemas 2 DELETE8 GET1 PATCH4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2023-12-15
Resource Areas
1

Paths & Operations 16

Across 14 paths, the API surfaces 16 operations — 2 DELETE, 8 GET, 1 PATCH, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Workflows 16

A workflow is a sequence of tasks that are performed based on predefined logic. A workflow improves efficiency and reduces errors by automating a series of complex tasks that othe…

GET
/workflows
List workflows
GET_Workflows 13 params → 200
GET
/workflows/{workflow_id}
Retrieve a workflow
GET_Workflow 7 params → 200
DELETE
/workflows/{workflow_id}
Delete a workflow
DELETE_Workflow 7 params → 200404
PATCH
/workflows/{workflow_id}
Update a workflow
PATCH_UpdateWorkflow 9 params → 200404422
GET
/workflows/workflow_runs/{workflow_run_id}
Retrieve a workflow run
GET_Workflow_Run 7 params → 200
POST
/workflows/{workflow_id}/run
Run a workflow
POST_Run_Workflow 9 params → 200400409406
GET
/workflows/{workflow_id}/export
Export a workflow version
GET_WorkflowExport 6 params → 200400404
POST
/workflows/import
Import a workflow
POST_WorkflowImport 9 params → 200
POST
/workflows/{workflow_id}/versions/import
Import a workflow version
POST_WorkflowVersionsImport 9 params → 200
DELETE
/versions/{version_id}
Delete a workflow version
DELETE_WorkflowVersion 5 params → 200403
GET
/workflows/{workflow_id}/versions
List all versions of a workflow definition
GET_WorkflowVersions 5 params → 200
GET
/workflows/tasks
List workflow tasks
GET_WorkflowsTasks 17 params → 200
GET
/workflows/tasks/{task_id}
Retrieve a workflow task
GET_WorkflowsTask 7 params → 200
POST
/workflows/tasks/{task_id}/rerun
Rerun a workflow task
POST_WorkflowsTaskRerun 8 params → 200
PUT
/workflows/tasks/batch_update
Update workflow tasks
PUT_WorkflowsTasksUpdate 7 params → 200400404
GET
/workflows/metrics.json
Retrieve workflow task usage
GET_WorkflowsUsages 9 params → 200

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are Task (21 properties), DetailedWorkflow (19 properties), WorkflowDefinitionAndVersions (13 properties), WorkflowDefinition (12 properties). Each schema is shown below with its type and property counts.

PutTasksRequest
object
1 property
DeleteWorkflowSuccess
object
2 properties
UpdateTask
object
A task.
10 properties 1 required
ExportWorkflowVersionResponse
object
3 properties
WorkflowDefinition
object
A workflow.
12 properties
UsagesResponse
object
1 property
WorkflowDefinitionAndVersions
object
A workflow.
13 properties
GetVersionsResponse
object
1 property
GetWorkflowResponse
object
12 properties
ValidationErrors
object
2 properties
Task
object
A task.
21 properties
POSTWorkflowDefinitionImportRequest
object
3 properties
BadRequestResponse
object
1 property
DetailedWorkflow
object
A workflow.
19 properties
Linkage
object
Used to represent the relationship between workflow tasks
4 properties
DeleteWorkflowError
object
1 property
GetWorkflowsResponse
object
2 properties
WorkflowInstance
object
A instance workflow object.
6 properties
WorkflowError
object
3 properties
Usage
object
The task usage of a particular day.
2 properties
ValidationReasons
object
2 properties
TasksResponse
object
2 properties
Workflow
object
A workflow.
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-workflows-api-openapi.yml Raw ↑

Other APIs Zuora publishes across the network.

Zuora V1 API
Zuora Accounting Codes API
Zuora Accounting Periods API
Zuora Accounts API
Zuora Actions API
Zuora Aggregate Queries API
Zuora API Health API
Zuora Attachments API
Zuora Bill Run API
Zuora Bill Run Health API
Zuora Billing Documents API
Zuora Billing Preview Run API