API Reference›LMS API›Reporting›List report definitions

List report definitions

GEThttps://sandbox.api.lendeasy.ai/v1/reports Bearer token · READ_REPORT

Returns the operational report catalog with each report’s parameters. This surface is definition metadata; report execution and downloads are operator-side and are not part of the public API.

Request

curl https://sandbox.api.lendeasy.ai/v1/reports \
  -H "Authorization: Bearer $TOKEN"

await fetch(`https://sandbox.api.lendeasy.ai/v1/reports`, {
  method: "GET",
  headers: { Authorization: `Bearer ${token}` },
});

requests.get(
  f"https://sandbox.api.lendeasy.ai/v1/reports",
  headers={"Authorization": f"Bearer {token}"},
)

[
  {
    "id": 81,
    "reportName": "Credit balance accounts",
    "reportType": "Table",
    "reportCategory": "Loan",
    "useReport": true,
    "reportParameters": [
      {
        "id": 1,
        "parameterName": "asOfDate"
      }
    ]
  }
]

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}

Path & query parameters

Field	Type	Description
LendEasy-Tenant required in header	string	Tenant selector: lowercase letters, digits, and hyphens, 1-64 characters. Exactly one instance; the only tenant selector honored.

Request

curl https://sandbox.api.lendeasy.ai/v1/reports \
  -H "Authorization: Bearer $TOKEN"

await fetch(`https://sandbox.api.lendeasy.ai/v1/reports`, {
  method: "GET",
  headers: { Authorization: `Bearer ${token}` },
});

requests.get(
  f"https://sandbox.api.lendeasy.ai/v1/reports",
  headers={"Authorization": f"Bearer {token}"},
)

[
  {
    "id": 81,
    "reportName": "Credit balance accounts",
    "reportType": "Table",
    "reportCategory": "Loan",
    "useReport": true,
    "reportParameters": [
      {
        "id": 1,
        "parameterName": "asOfDate"
      }
    ]
  }
]

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}