Billing Emails

Query the billing email records. Combine business filters through filters, and control pagination with page and page_size.

Response

On success, returns the matching list of records together with pagination information. See each field's documentation for the purpose, allowed values, and dynamic data source of every filter.

GEThttps://b-api.longbridge.xyz/v1/datasets/booking_mails

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

AuthorizationstringheaderRequired

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

Permission

No dedicated permission key. Any authenticated Broker ACCESS_TOKEN with access to this scope can call it.

Query parameters

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes

ledger_dateobject

Filters results by Message Date.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

Aaidstring

Filters results by Client.

statestring

Filters results by State.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

0 · Pending Send1 · Sent Successfully2 · Send Failed3 · Sending

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Billing Email records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Returned value: List of list.

Child attributes

ledger_datestring

Returned value: Message Date. The date or time format follows the value returned by the API.

origin_idstring

Returned value: A/C No..

client_detail_typestring

Returned value: Client Detail Type.

real_namestring

Returned value: Client Name.

langstring

Returned value: Language.

lang_valstring

Raw value of lang. The lang field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

billing_item_modifystring

Returned value: Fee Logic Update.

billing_item_modify_valstring

Raw value of billing_item_modify. The billing_item_modify field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

dft_package_modifystring

Returned value: Global Client Group Update.

dft_package_modify_valstring

Raw value of dft_package_modify. The dft_package_modify field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

common_package_modifystring

Returned value: General Client Group Update.

common_package_modify_valstring

Raw value of common_package_modify. The common_package_modify field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

personal_package_modifystring

Returned value: Client charge Configure Update.

personal_package_modify_valstring

Raw value of personal_package_modify. The personal_package_modify field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

config_updated_atstring

Returned value: Configuration Update Time. The date or time format follows the value returned by the API.

mail_send_atstring

Returned value: Email Send Time. The date or time format follows the value returned by the API.

statestring

Returned value: State.

state_valstring

Raw value of state. The state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

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 --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/booking_mails' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "ledger_date": "20260714",
        "origin_id": "H00000000",
        "client_detail_type": "OB",
        "real_name": "示例用户",
        "lang": "Simplified Chinese",
        "lang_val": "zh-CN",
        "billing_item_modify": "NO",
        "billing_item_modify_val": "false",
        "dft_package_modify": "YES",
        "dft_package_modify_val": "true",
        "common_package_modify": "YES",
        "common_package_modify_val": "true",
        "personal_package_modify": "NO",
        "personal_package_modify_val": "false",
        "config_updated_at": "2026-07-16 14:38:11",
        "mail_send_at": "user@example.com",
        "state": "Pending Send",
        "state_val": "0"
      }
    ],
    "total": 42
  }
}