Remarks template · Whale Docs

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

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>.

Query parameters

filtersobject

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

Child attributes

idstring

Filters results by ID.

config_value_multi_langstring

Filters results by Remarks.

updated_atobject

Filters results by Updated At.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

lookup_categorystring

Filters results by Remarks User.

Allowed values:

setting_remark_deposit - Deposit
setting_remark_withdrawal - Withdrawal
setting_remark_securitiesdeposit - Securities Deposit
setting_remark_securitieswithdrawal - Securities Withdrawal
setting_remark_accountadjustment - Account Adjustment
setting_remark_withdrawal_reject - Withdrawal rejection
setting_remark_deposit_reject - Deposit rejection
setting_remark_withdrawal_card_reject - Refuse Add Bank Card
setting_remark_fund - Fund
setting_remark_otc_derivatives - OTC Derivatives
setting_remark_deposit_matching - Deposit Matching

setting_remark_deposit · Depositsetting_remark_withdrawal · Withdrawalsetting_remark_securitiesdeposit · Securities Depositsetting_remark_securitieswithdrawal · Securities Withdrawalsetting_remark_accountadjustment · Account Adjustmentsetting_remark_withdrawal_reject · Withdrawal rejectionsetting_remark_deposit_reject · Deposit rejectionsetting_remark_withdrawal_card_reject · Refuse Add Bank Cardsetting_remark_fund · Fundsetting_remark_otc_derivatives · OTC Derivativessetting_remark_deposit_matching · Deposit Matching

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Remarks template 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

idstring

Returned value: Unique identifier of the current record.

lookup_categorystring

Returned value: Remarks User.

lookup_category_valstring

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

value_enstring

Returned value: Remarks - English.

value_cnstring

Returned value: Remarks - Simplified Chinese.

value_hkstring

Returned value: Remarks - Traditional Chinese.

prioritystring

Returned value: Priority.

created_atstring

Returned value: Created At. The date or time format follows the value returned by the API.

updated_atstring

Returned value: Updated At. The date or time format follows the value returned by the API.

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/atm_remark_templates' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "14625",
        "lookup_category": "Deposit Matching",
        "lookup_category_val": "setting_remark_deposit_matching",
        "value_en": "add setting_remark_deposit_matching english remark4627",
        "value_cn": "新增setting_remark_deposit_matching简体备注8871",
        "value_hk": "新增setting_remark_deposit_matching繁體備註9281",
        "priority": "175958",
        "created_at": "2026-06-30 06:19:59",
        "updated_at": "2026-06-30 06:19:59"
      }
    ],
    "total": 84
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.longbridge.xyz/v1/datasets/atm_remark_templates/download

Export options Export records Download result