PApaddlehq
Reports

List reports

Changed on

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.

get/reports

Request

  • Base URL
    https://sandbox-api.paddle.com
  • Auth
    HTTP bearer

Query parameters

afterstring

Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.

per_pageinteger

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.

order_bystring

Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC].

Valid fields for ordering: id.

statusReportStatusQueryEnum[]

Return entities that match the specified status. Use a comma-separated list to specify multiple status values.

Headers

Skip-Countstring

Set to true to skip the count query on list operations. When set, meta.pagination.estimated_total returns -1 instead of an exact count.

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "id": "txnitm_01gm302t81w94gyjpjpqypkzkf",
      "expires_at": "2024-10-12T07:20:50.52Z",
      "updated_at": "2024-10-13T07:20:50.52Z",
      "created_at": "2024-10-12T07:20:50.52Z",
      "type": "adjustments",
      "filters": [
        {
          "operator": "lt",
          "value": "2024-10-12T07:20:50.52Z"
        }
      ]
    }
  ],
  "meta": {
    "request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355",
    "pagination": {
      "estimated_total": 999
    }
  }
}

Changes

  • v14f35a8c6ea4dRevision changes
    • breaking

      added to the / response property oneOf list for the response status

  • v1e1ac347eb3c5Revision changes
    • breaking

      added to the / response property oneOf list for the response status

    • info

      added the new optional header request parameter Skip-Count

    • info

      added subschema #1 subschema #2 subschema #4 to the ///// response property anyOf list for the response status