Get Report List

Returns the report list, grouped by report category.

Request parameters

This endpoint takes no required parameters.
Optional: category_id (report category ID; omit to query all categories).

Returns

On success, data.list contains the reports grouped by category: each item includes the category info category and the array of reports reports under it. data.update_hint returns the update-notice text for the report data. See the response definition below for field details.

GEThttps://b-api.lbkrs.com/report/list

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

lb_hk_report.report_printing

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Parameters

category_idstring

Filter by report category ID. Returns all when omitted.

Responses

HTTP 200The request was processed successfully. The business result is in data.list.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>

Reports grouped by category.

Child attributes

categoryobject

Report category information for this group.

Child attributes

category_idstring

Report category ID.

reportsarray<object>

Reports under this category. Each item is a report object.

update_hintstring

Text hint describing the report data's update status.

HTTP 400Bad request. Check the business error code in code and the error details in message.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

Request

curl --request GET \
  --url 'https://b-api.lbkrs.com/report/list' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "category": {
          "category_id": "C-0001"
        },
        "reports": []
      }
    ],
    "update_hint": ""
  }
}