Customer Search · Whale Docs

GEThttps://b-api.longbridge.xyz/crm-api/v3/customers/search

Authorization

AuthorizationstringheaderRequired

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

Parameters

origin_idstringOptional

A/C No.

member_idstringOptional

Member ID

phone_numberstringOptional

Phone Number

accountstringOptional

App Account

contact_phonestringOptional

Phone Contact

emailstringOptional

open_emailstringOptional

Contact Email

real_namestringOptional

Real Name

card_idstringOptional

ID Card/Passport

aaidstringOptional

AAID

uuidstringOptional

UUID

modestringRequired

The isolation mode for customer search. This endpoint always passes accounted (query customers who have opened accounts, with tenant isolation).

Responses

HTTP 200Returns business fields.

Standard response envelopecodemessagedata

dataobjectdata structure

bodyarray<object>

Customer List. Each element is shaped like { body: }.

Request

curl --request GET \
  --url 'https://b-api.longbridge.xyz/crm-api/v3/customers/search' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'

Response

{
  "code": 0,
  "message": null,
  "data": {
    "body": [
      {}
    ]
  }
}