List reports
Returns a paginated list of reports. Use the query parameters to page through results.
By default, Paddle returns reports that are pending
or ready
. Use the status
query parameter to return reports that are failed
, expired
, or deleted
.
Query Parameters
Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next
URL in responses for list operations.
Order returned entities by the specified field and direction ([ASC]
or [DESC]
). For example, ?order_by=id[ASC]
.
Valid fields for ordering: id
.
Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is requested. Check meta.pagination.per_page
in the response to see how many were returned.
Default: 50
; Maximum: 200
.
Return entities that match the specified status. Use a comma-separated list to specify multiple status values.
Response
Represents a report entity.
Unique Paddle ID for this report, prefixed with rep_
Status of this report. Set automatically by Paddle.
Reports are created as pending
initially, then move to ready
when they're available to download.
Number of records in this report. null
if the report is pending
.
Type of report.
List of filters applied to this report.
RFC 3339 datetime string of when this report expires. The report is no longer available to download after this date.
RFC 3339 datetime string of when this report was last updated.
RFC 3339 datetime string of when this report was created.
Information about this response.
Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
Keys used for working with paginated results.