JUjustifi
Reports

List Reports

List all generated reports

get/reports

Request

Query parameters

nicknamestring

the nickname of the report

Headers

Authorizationstring required

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Sub-Accountstring

the id of the sub account that this request applies to

Response

Successfully list reports

idnumber

the object id

typestring

the object type, or array of objects

Example response

{
  "id": 1,
  "type": "array",
  "data": [
    {
      "id": "rpt_xyz",
      "report_type": "proceeds",
      "nickname": "My Report",
      "status": "scheduled",
      "scheduled_at": "2025-12-25T14:44:45.026Z",
      "run_at": "2025-12-30T14:44:45.026Z",
      "created_at": "2025-12-31T14:44:45.026Z",
      "account_id": "acc_xyz",
      "platform_account_id": "acc_xyz",
      "parameters": {
        "start_date": "2025-12-25",
        "end_date": "2025-12-30",
        "nickname": "My Report",
        "account_id": "acc_xyz",
        "platform_account_id": "acc_xyz"
      }
    }
  ],
  "page_info": {
    "end_cursor": "WyIyMDIyLTAyLTA4IDE5OjUyOjM3LjEwNDE3MzAwMCIsIjY4MDliYTU5LTYxYjctNDg3MS05YWFiLWE2Y2MyNmY3M2M1ZCJd",
    "start_cursor": "WyIyMDIyLTAyLTA4IDIwOjAxOjU4LjEyMDIzMjAwMCIsIjU5ZTFjNGI1LWFlOWQtNDIyZC04MTVkLWNjNzQ5NzdlYmFjYSJd"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.