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 Data Queries API

The Data Query feature enables you to perform SQL queries in your Zuora tenant. To learn how to get started with Data Query, see [Overview of Data Query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query/A_Overview_of_Data_Query).

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

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

This API exposes 4 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.

4 operations 2 paths 9 schemas 1 DELETE2 GET1 POST

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 4

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

Data Queries 4

The Data Query feature enables you to perform SQL queries in your Zuora tenant. To learn how to get started with Data Query, see [Overview of Data Query](https://knowledgecenter.z…

POST
/query/jobs
Submit a data query
POST_DataQueryJob 8 params → 200400
GET
/query/jobs
List data query jobs
GET_DataQueryJobs 8 params → 200
GET
/query/jobs/{job-id}
Retrieve a data query job
GET_DataQueryJob 7 params → 200403404
DELETE
/query/jobs/{job-id}
Cancel a data query job
DELETE_DataQueryJob 7 params → 200400

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are SubmitDataQueryRequest (10 properties), DataQueryJobCommon (7 properties), DataQueryErrorResponse (2 properties), GetDataQueryJobResponse (1 property). Each schema is shown below with its type and property counts.

GetDataQueryJobsResponse
object
1 property
DeleteDataQueryJobResponse
object
1 property
DataQueryErrorResponse
object
2 properties
SubmitDataQueryResponse
object
1 property
DataQueryJobCommon
object
7 properties
DataQueryJobCancelled
A cancelled data query job.
DataQueryJob
A data query job.
SubmitDataQueryRequest
object
10 properties 4 required
GetDataQueryJobResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-data-queries-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