Skip to main content
GET
/
reports
/
{report_id}
Get a report
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paddle.com/reports/{report_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "data": {
    "id": "rep_01hvgdhtthn1q35n79dgeqm3pv",
    "type": "transactions",
    "rows": 27,
    "status": "ready",
    "filters": [
      {
        "name": "collection_mode",
        "value": [
          "manual"
        ],
        "operator": null
      },
      {
        "name": "updated_at",
        "value": "2024-04-15",
        "operator": "lt"
      },
      {
        "name": "updated_at",
        "value": "2024-01-01",
        "operator": "gte"
      }
    ],
    "expires_at": "2024-04-29T08:21:44.970769Z",
    "created_at": "2024-04-15T08:21:36.209Z",
    "updated_at": "2024-04-15T08:21:44.970774Z"
  },
  "meta": {
    "request_id": "2a174f15-0ae6-4330-bf19-aae16a04d838"
  }
}

Authorizations

Authorization
string
header
required

Requests are authenticated with API keys. Provide your API key as a Bearer token in the Authorization header.

API keys are assigned permissions, granting them access to entities and operations. Each endpoint may require one or more permissions, defined with the x-permissions extension. Values for include parameters may require specific permissions as defined in the x-enum-permissions extension. See all available permissions in the permission schema or documentation.

Get an API key and select the permissions you need from the Paddle dashboard under Paddle > Developer Tools > Authentication.

Path Parameters

report_id
string
required

Paddle ID of the report entity.

Example:

"rep_01gvne87kv8vbqa9jkfbmgtsed"

Response

OK

data
Adjustments reports · object
required

Entity when working with reports for adjustments or adjustment line items.

meta
Meta · object
required

Information about this response.