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

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

post

/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

customerNostringrequired

Customer Number

sizenumber

Number of rows displayed per page, default is 20

currentnumber

Current page, default is 1

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://pre-api-test.cmfbl.com/openapi-b/customer.admin.WhiteCustomerAdminApiService.page' \
  --header 'trace: text' \
  --header 'token: text' \
  --header 'version: text' \
  --header 'companyId: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "customerNo": null,
    "size": 20,
    "current": 1
  }'

200

200

{
  "bizCode": "",
  "code": "",
  "fail": true,
  "msg": "",
  "msgParams": "",
  "ok": true,
  "tm": 0,
  "trace": "",
  "data": {
    "current": 0,
    "size": 0,
    "total": 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
      }
    ]
  }
}

Success