List the columns of a layout

Revenue API

List the columns of a layout

Request

Returns only the output columns of a layout, in output order.

Purpose: Map the columns of the output file to your target system (for example a data warehouse table) before you download it.

When to use: When you load the output file into another system and need the column order, names and data types to map the file to a target table.

Notes:

The layout must belong to the report in the path; otherwise the response is 404.
This operation returns the column labels and data types stored on the layout columns. They are not translated and can differ from the values returned inside List layouts and Get a layout.

Request definition

Parameter	In	Type	Required	Description
`reportId`	path	integer	Yes	Identifier of the report.
`layoutId`	path	integer	Yes	Identifier of the layout.
`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`	LayoutFieldList
`400`	`application/json`	SpringError
`401`	`application/json`	GatewayError
`403`	`application/json`	GatewayError
`404`	none	No body
`429`	`application/json`	GatewayError
`500`	`application/json`	ServiceError

LayoutFieldList: Wrapper returned by the list-layout-fields operation.

Field	Type	Required	Description
`layoutFields`	array of LayoutField	No	Output columns of the layout.
`layoutFields[].id`	integer	No	Unique identifier of this column assignment within the layout.
`layoutFields[].layoutId`	integer	No	Identifier of the layout the column belongs to.
`layoutFields[].fieldId`	integer	No	Identifier of the underlying report field (column definition).
`layoutFields[].seq`	integer	No	Position of the column in the output file. Lower numbers appear further left.
`layoutFields[].sortSeq`	integer	No	Sort priority of the column. `null` when the layout does not sort by this column.
`layoutFields[].fieldName`	string	No	Technical field name in lowerCamelCase. Use this value as `fieldName` when you filter a report run.
`layoutFields[].fieldLabel`	string	No	Column heading shown in the output file, translated to the caller's language when a translation exists.
`layoutFields[].fieldType`	string	No	Database data type of the column, for example `VARCHAR2`, `NUMBER`, `DATE` or `DATE_TIME`.

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.

Example:10021

layoutIdinteger, (int32)required

Identifier of the layout.

Example:3105

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/layouts/3105/fields \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Zuora-Track-Id: close-run-2026-09-001'

Responses

Success. The columns of the layout.

Bodyapplication/json

layoutFieldsArray of objects(LayoutField)

Output columns of the layout.

Response

{
  "layoutFields": [
    { … },
    { … },
    { … }
  ]
}