Skip to main content
GET
/
v1
/
reports
/
{id}
Get a report
curl --request GET \
  --url https://api.ledger.so/v1/reports/{id} \
  --header 'Authorization: Bearer <token>'
{
  "ok": true,
  "data": {
    "id": "rpt_yza567",
    "createdAt": "2025-01-31T00:00:00Z",
    "type": "monthly_statement",
    "status": "pending",
    "downloadUrl": "<string>"
  }
}

Authorizations

Authorization
string
header
required

API key passed as a Bearer token. Format: ld_<env>_<prefix>_<secret> where <env> is test or live.

Path Parameters

id
string
required

The report ID (prefixed with rpt_).

Example:

"rpt_yza567"

Response

The requested report

ok
boolean
required

Indicates the request was successful.

data
object