Customer List

Query customer list, paging

It is suitable for white label users to query all customer information. Considering that there are a large number of customers, they can be obtained in batches. The quantity of each batch can be specified. The default maximum is no more than 2,000 items.

Customer basic information

post

version=0.0.1 bizType=customer.admin.WhiteCustomerAdminApiService.page

Header parameters

tracestringRequired

Global link unique identifier

Example: {{mock_trace}}

tokenstringRequired

Authentication code

Example: {{auto_token}}

versionstringRequired

Interface version number

Example: 0.0.1

companyIdstringRequired

Company ID

Example: {{company}}

Body

application/json

customerNostringRequired

Customer Number

sizenumberOptional

Number of rows displayed per page, default is 20

currentnumberOptional

Current page, default is 1

Responses

200

Success

application/json

agentCustomerNostringOptional

Agent number

companyIdinteger · int64Optional

Company

createTimeinteger · int64Optional

Creation time / Application time

customerGroupIdinteger · int64Optional

Customer group Id

customerGroupNamestringOptional

Customer group name

customerNostringOptional

Customer account

customerTypeinteger · int32Optional

Customer type 0 default 1 agent 2 credit 3 activity settlement

emailstringOptional

Email

firstAccountActivateTimeinteger · int64Optional

First activation time of trading account

firstNamestringOptional

Name

idinteger · int64Optional

id

idCardstringOptional

ID number

idCardTypestringOptional

ID type

lastNamestringOptional

Last name

loginTimeinteger · int64Optional

Login time

namestringOptional

First name

openAccountTypeinteger · int32Optional

Account type: 0. Individual 1. Business

phonestringOptional

Phone number

phoneAreastringOptional

Phone area code

registerSourceinteger · int32Optional

Registration source

remarkstringOptional

Remarks

statusinteger · int32Optional

Status: 1. Normal, 2. Disabled, 3. Deleted, 4. Closed account, 5. Locked, 6. Closing account

tgUserIdstringOptional

tgUserId

tgUserNamestringOptional

tgUserName

thirdAccountNostringOptional

Third-party account

thirdLoginSourcestringOptional

thirdLoginSource

thirdUserIdstringOptional

thirdUserId

unitIdinteger · int64Optional

Institution ID

unitNamestringOptional

Institution name

updateTimeinteger · int64Optional

Update time

post

/customer.admin.WhiteCustomerAdminApiService.page

HTTPcURLJavaScriptPython

POST /openapi-b/customer.admin.WhiteCustomerAdminApiService.page HTTP/1.1
Host: pre-api-test.cmfbl.com
trace: text
token: text
version: text
companyId: text
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "customerNo": null,
  "size": 20,
  "current": 1
}

200

Success

{
  "bizCode": "",
  "code": "",
  "data": {
    "current": 0,
    "records": [
      {
        "agentCustomerNo": "",
        "companyId": 0,
        "createTime": 0,
        "customerGroupId": 0,
        "customerGroupName": "",
        "customerNo": "",
        "customerType": 0,
        "email": "",
        "firstAccountActivateTime": 0,
        "firstName": "",
        "id": 0,
        "idCard": "",
        "idCardType": "",
        "lastName": "",
        "loginTime": 0,
        "name": "",
        "openAccountType": 0,
        "phone": "",
        "phoneArea": "",
        "registerSource": 0,
        "remark": "",
        "status": 0,
        "tgUserId": "",
        "tgUserName": "",
        "thirdAccountNo": "",
        "thirdLoginSource": "",
        "thirdUserId": "",
        "unitId": 0,
        "unitName": "",
        "updateTime": 0
      }
    ],
    "size": 0,
    "total": 0
  },
  "fail": true,
  "msg": "",
  "msgParams": "",
  "ok": true,
  "tm": 0,
  "trace": ""
}