Skip to content
Longport WhaleLongport Whale
Client Group

Client Group Query

Queries Client Group Query data. Combine business filters in filters, and use page, page_size, and orderBy to control pagination and sorting.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

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

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

credit_limit.client_group_query

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

Query parameters

filtersobject

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

Child attributes
namestring

Group Name. Filters results by Group Name.

account_no_liststring

A/C No.. Filters results by A/C No..

business_typestring

Business Type. Filters results by Business Type.

1 · Margin2 · Report3 · Risk Control Parameters

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Client Group Query records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List. Returned value: List of list.

Child attributes
idstring

Group ID. Returned value: Unique identifier of the current record.

business_typestring

Business Type. Returned value: Business Type.

business_type_valstring

Business Type (raw value). Raw value of business_type. The business_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

namestring

Group Name. Returned value: Group Name.

countstring

Client Number. Returned value: Client Number.

remarkstring

Remark. Returned value: Remark.

updated_atstring

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

op_userstring

Operator. Returned value: Operator.

totalintegerrequired

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

Whale Docs