User List

GET /merchant/user/list

User List

cURL

curl --request GET \
  --url https://api.unibee.dev/merchant/user/list \
  --header 'Authorization: Bearer <token>'

200

{
  "code": 123,
  "data": {
    "total": 123,
    "userAccounts": [
      {
        "address": "<string>",
        "avatarUrl": "<string>",
        "billingType": 123,
        "birthday": "<string>",
        "city": "<string>",
        "companyName": "<string>",
        "countryCode": "<string>",
        "countryName": "<string>",
        "createTime": 123,
        "creditAccounts": [
          {
            "amount": 123,
            "createTime": 123,
            "currency": "<string>",
            "currencyAmount": 123,
            "exchangeRate": 123,
            "id": 123,
            "payoutEnable": 123,
            "rechargeEnable": 123,
            "totalDecrementAmount": 123,
            "totalIncrementAmount": 123,
            "type": 123,
            "userId": 123
          }
        ],
        "custom": "<string>",
        "email": "<string>",
        "externalUserId": "<string>",
        "facebook": "<string>",
        "firstName": "<string>",
        "gateway": {
          "IsSetupFinished": true,
          "archive": true,
          "autoChargeEnabled": true,
          "bank": {
            "accountHolder": "<string>",
            "address": "<string>",
            "ABARoutingNumber": "<string>",
            "CNAPS": "<string>",
            "Remarks": "<string>",
            "accountNumber": "<string>",
            "bankName": "<string>",
            "bic": "<string>",
            "bsbCode": "<string>",
            "iban": "<string>",
            "swiftCode": "<string>"
          },
          "companyIssuer": {
            "issueAddress": "<string>",
            "issueCompanyName": "<string>",
            "issueLogo": "<string>",
            "issueRegNumber": "<string>",
            "issueVatNumber": "<string>"
          },
          "countryConfig": {},
          "createTime": 123,
          "currency": "<string>",
          "currencyExchange": [
            {
              "exchange_rate": 123,
              "from_currency": "<string>",
              "to_currency": "<string>"
            }
          ],
          "currencyExchangeEnabled": true,
          "defaultGatewayPaymentType": {
            "autoCharge": true,
            "category": "<string>",
            "countryName": "<string>",
            "name": "<string>",
            "paymentType": "<string>",
            "supportCurrencies": [
              "<string>"
            ]
          },
          "description": "<string>",
          "displayName": "<string>",
          "gatewayIcons": [
            "<string>"
          ],
          "gatewayId": 123,
          "gatewayKey": "<string>",
          "gatewayLogo": "<string>",
          "gatewayName": "<string>",
          "gatewayPaymentTypes": [
            {
              "autoCharge": true,
              "category": "<string>",
              "countryName": "<string>",
              "name": "<string>",
              "paymentType": "<string>",
              "supportCurrencies": [
                "<string>"
              ]
            }
          ],
          "gatewaySecret": "<string>",
          "gatewayType": 123,
          "gatewayWebhookIntegrationLink": "<string>",
          "gatewayWebsiteLink": "<string>",
          "isDefault": true,
          "metadata": {},
          "minimumAmount": 123,
          "name": "<string>",
          "privateSecretName": "<string>",
          "publicKeyName": "<string>",
          "setupGatewayPaymentTypes": [
            {
              "autoCharge": true,
              "category": "<string>",
              "countryName": "<string>",
              "name": "<string>",
              "paymentType": "<string>",
              "supportCurrencies": [
                "<string>"
              ]
            }
          ],
          "sort": 123,
          "subGateway": "<string>",
          "subGatewayName": "<string>",
          "webhookEndpointUrl": "<string>",
          "webhookSecret": "<string>"
        },
        "gatewayId": 123,
        "gatewayPaymentType": "<string>",
        "gender": "<string>",
        "id": 123,
        "isRisk": 123,
        "isSpecial": 123,
        "language": "<string>",
        "lastLoginAt": 123,
        "lastName": "<string>",
        "linkedIn": "<string>",
        "merchantId": 123,
        "metadata": {},
        "mobile": "<string>",
        "otherSocialInfo": "<string>",
        "paymentMethod": "<string>",
        "phone": "<string>",
        "planId": 123,
        "promoCreditAccounts": [
          {
            "amount": 123,
            "createTime": 123,
            "currency": "<string>",
            "currencyAmount": 123,
            "exchangeRate": 123,
            "id": 123,
            "payoutEnable": 123,
            "rechargeEnable": 123,
            "totalDecrementAmount": 123,
            "totalIncrementAmount": 123,
            "type": 123,
            "userId": 123
          }
        ],
        "recurringAmount": 123,
        "registrationNumber": "<string>",
        "school": "<string>",
        "state": "<string>",
        "status": 123,
        "subscriptionId": "<string>",
        "subscriptionName": "<string>",
        "subscriptionStatus": 123,
        "taxPercentage": 123,
        "telegram": "<string>",
        "tikTok": "<string>",
        "timeZone": "<string>",
        "type": 123,
        "userName": "<string>",
        "vATNumber": "<string>",
        "version": 123,
        "weChat": "<string>",
        "whatsAPP": "<string>",
        "zipCode": "<string>"
      }
    ]
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Endpoint Overview

GET https://api.unibee.dev/merchant/user/list

User List

---

Authorization

All UniBee Merchant API requests require authentication via API key.

Header	Required	Description
Authorization	Yes	Bearer <your_api_key>
Content-Type	Yes	application/json (for request body)

---

Parameters

Parameters for this endpoint are listed below. The schema is also shown in the Try it panel.

Query parameters

Name	Type	Required	Description
userId	integer	No	Filter UserId
externalUserId	string	No	ExternalUserId
firstName	string	No	Search FirstName
lastName	string	No	Search LastName
email	string	No	Search Filter Email
searchKey	string	No	Search FirstName|LastName|Email|Phone|Address|ExternalUserId
planIds	array	No	PlanIds, Search Filter PlanIds
gatewayIds	array	No	GatewayIds, Search Filter GatewayIds
subscriptionId	string	No	Search Filter SubscriptionId
subStatus	array	No	Filter, Default All，1-Pending｜2-Active｜3-Suspend | 4-Cancel | 5-Expire | 6- Suspend| 7-Incomplete | 8-Processing | 9-Failed
status	array	No	Status, 0-Active｜2-Frozen
deleteInclude	boolean	No	Deleted Involved，Need Admin
sortField	string	No	Sort，user_id|gmt_create|email|user_name|subscription_name|subscription_status|payment_method|recurring_amount|billing_type，Default gmt_create
sortType	string	No	Sort Type，asc|desc，Default desc
page	integer	No	Page,Start 0
count	integer	No	Count OF Page
createTimeStart	integer	No	CreateTimeStart，UTC timestamp，seconds
createTimeEnd	integer	No	CreateTimeEnd，UTC timestamp，seconds

---

Request examples

cURL

curl -X GET "https://api.unibee.dev/merchant/user/list" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Sandbox

curl -X GET "https://api-sandbox.unibee.top/merchant/user/list" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json"

---

Response

Success responses return a JSON envelope with code, data, message, redirect, and requestId. code 0 indicates success.

Field	Type	Description
code	integer	Response code. 0 = success
data	object	Response payload
data.total	integer	Total
data.userAccounts	array	User Account Object List
message	string	Human-readable message
requestId	string	Request ID for support

---

Error handling

HTTP status	Meaning
400	Bad request — invalid or missing parameters. Check message in the body.
401	Unauthorized — missing or invalid API key.
404	Not found — invalid path or resource.
500	Server error — retry with backoff.

When code in the response body is non-zero, check message for details. Use requestId when contacting support.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

userId · integer<int64>

Filter UserId

externalUserId · string<string>

ExternalUserId

firstName · string<string>

Search FirstName

lastName · string<string>

Search LastName

email · string<string>

Search Filter Email

searchKey · string<string>

Search FirstName|LastName|Email|Phone|Address|ExternalUserId

planIds · integer<int>[]

PlanIds, Search Filter PlanIds

gatewayIds · integer<int64>[]

GatewayIds, Search Filter GatewayIds

subscriptionId · string<string>

Search Filter SubscriptionId

subStatus · integer<int>[]

Filter, Default All，1-Pending｜2-Active｜3-Suspend | 4-Cancel | 5-Expire | 6- Suspend| 7-Incomplete | 8-Processing | 9-Failed

status · integer<int>[]

Status, 0-Active｜2-Frozen

deleteInclude · boolean<bool>

Deleted Involved，Need Admin

sortField · string<string>

Sort，user_id|gmt_create|email|user_name|subscription_name|subscription_status|payment_method|recurring_amount|billing_type，Default gmt_create

sortType · string<string>

Sort Type，asc|desc，Default desc

page · integer<int>

Page,Start 0

count · integer<int>

Count OF Page

createTimeStart · integer<int64>

CreateTimeStart，UTC timestamp，seconds

createTimeEnd · integer<int64>

CreateTimeEnd，UTC timestamp，seconds

Response

200 - application/json

code · integer<int>

data · object

Show child attributes

merchantId · integer<int64>

message · string<string>

redirect · string<string>

requestId · string<string>