Retrieve a report

Revenue API

Retrieve a report

Request

Returns one report definition by its identifier.

Purpose: Confirm that a report exists and read its name, category and audit details before you list its layouts or run it.

When to use: When you already have a report ID (from configuration or a previous call) and want to confirm it still exists before you list layouts or run it.

Request definition

Parameter	In	Type	Required	Description
`reportId`	path	integer	Yes	Identifier of the report (`id` from List reports).
`Zuora-Track-Id`	header	string	No	Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.
`Authorization`	header	string	Yes	`Bearer <access_token>` (Zuora OneID OAuth).

Request body: none.

Response definition

HTTP status	Content type	Response schema
`200`	`application/json`	Report
`400`	`application/json`	SpringError
`401`	`application/json`	GatewayError
`403`	`application/json`	GatewayError
`404`	none	No body
`429`	`application/json`	GatewayError
`500`	`application/json`	ServiceError

Report: A report definition in the tenant's report catalog. A report describes a data set (for example revenue waterfall or deferred revenue balances). It does not contain row data.

Field	Type	Required	Description
`id`	integer	No	Unique numeric identifier of the report definition. Use it as `reportId` in every other Reports call.
`name`	string	No	Display name of the report. List reports returns the translated name when a translation exists for the caller's language; other operations return the stored name.
`description`	string	No	Business description of what the report contains.
`category`	string	No	Catalog grouping the report belongs to, as configured in Zuora Revenue.
`sequence`	integer	No	Display order of the report inside its category. Lower numbers are shown first.
`createdBy`	string	No	User name that created the report definition.
`createdAt`	string (date-time)	No	Date and time the report definition was created, formatted `yyyy-MM-dd'T'HH:mm:ss`.
`updatedBy`	string	No	User name that last changed the report definition.
`updatedAt`	string (date-time)	No	Date and time the report definition was last changed, formatted `yyyy-MM-dd'T'HH:mm:ss`.

Error response schemas (GatewayError, ServiceError, SpringError, SimpleError, MissingFiltersError, RunStatusConflict, RiaError, SignedUrlError) are defined once under Error response schemas in the API overview and in components/schemas.

Response codes: 200, 400, 401, 403, 404, 429, 500. Each response with a body includes worked examples; responses without a body say so.

Security

OneIdOAuth

Path

reportIdinteger, (int32)required

Identifier of the report (id from List reports).

Example:10021

Zuora-Track-Idstring

Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.

Example:close-run-2026-09-001

cURL

curl -i -X GET \
  https://one.zuora.com/revenue/services/v1/reports/10021 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Zuora-Track-Id: close-run-2026-09-001'

Responses

Success. The report.

Bodyapplication/json

idinteger, (int32)

Unique numeric identifier of the report definition. Use it as reportId in every other Reports call.

Example:10021

namestring

Display name of the report. List reports returns the translated name when a translation exists for the caller's language; other operations return the stored name.

Example:"Revenue Waterfall Report"

descriptionstring or null

Business description of what the report contains.

Example:"Recognized and scheduled revenue by period for each revenue contract line"

categorystring or null

Catalog grouping the report belongs to, as configured in Zuora Revenue.

Example:"Revenue"

sequenceinteger or null, (int32)

Display order of the report inside its category. Lower numbers are shown first.

Example:3

createdBystring or null

User name that created the report definition.

Example:"SYSADMIN"

createdAtstring or null, (date-time)

Date and time the report definition was created, formatted yyyy-MM-dd'T'HH:mm:ss.

Example:"2024-01-15T09:30:00"

updatedBystring or null

User name that last changed the report definition.

Example:"FIN.ADMIN"

updatedAtstring or null, (date-time)

Date and time the report definition was last changed, formatted yyyy-MM-dd'T'HH:mm:ss.

Example:"2026-08-02T14:05:11"

Response

{
  "id": 10021,
  "name": "Revenue Waterfall Report",
  "description": "Recognized and scheduled revenue by period for each revenue contract line",
  "category": "Revenue",
  "sequence": 3,
  "createdBy": "SYSADMIN",
  "createdAt": "2024-01-15T09:30:00",
  "updatedBy": "FIN.ADMIN",
  "updatedAt": "2026-08-02T14:05:11"
}