User List

User List

curl --request POST \
  --url https://api.unibee.dev/merchant/user/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "count": 123,
  "createTimeEnd": 123,
  "createTimeStart": 123,
  "deleteInclude": true,
  "email": "<string>",
  "externalUserId": "<string>",
  "firstName": "<string>",
  "gatewayIds": [
    123
  ],
  "lastName": "<string>",
  "page": 123,
  "planIds": [
    123
  ],
  "searchKey": "<string>",
  "sortField": "<string>",
  "sortType": "<string>",
  "status": [
    123
  ],
  "subStatus": [
    123
  ],
  "subscriptionId": "<string>",
  "userId": 123
}
'

{
  "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>"
}

POST

merchant

user

list

User List

curl --request POST \
  --url https://api.unibee.dev/merchant/user/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "count": 123,
  "createTimeEnd": 123,
  "createTimeStart": 123,
  "deleteInclude": true,
  "email": "<string>",
  "externalUserId": "<string>",
  "firstName": "<string>",
  "gatewayIds": [
    123
  ],
  "lastName": "<string>",
  "page": 123,
  "planIds": [
    123
  ],
  "searchKey": "<string>",
  "sortField": "<string>",
  "sortType": "<string>",
  "status": [
    123
  ],
  "subStatus": [
    123
  ],
  "subscriptionId": "<string>",
  "userId": 123
}
'

{
  "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

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

Request body

Name	Type	Required	Description
`count`	integer	No	Count OF Page
`createTimeEnd`	integer	No	CreateTimeEnd，UTC timestamp，seconds
`createTimeStart`	integer	No	CreateTimeStart，UTC timestamp，seconds
`deleteInclude`	boolean	No	Deleted Involved，Need Admin
`email`	string	No	Search Filter Email
`externalUserId`	string	No	ExternalUserId
`firstName`	string	No	Search FirstName
`gatewayIds`	array	No	GatewayIds, Search Filter GatewayIds
`lastName`	string	No	Search LastName
`page`	integer	No	Page,Start 0
`planIds`	array	No	PlanIds, Search Filter PlanIds
`searchKey`	string	No	Search FirstName\|LastName\|Email\|Phone\|Address\|ExternalUserId
`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
`status`	array	No	Status, 0-Active｜2-Frozen
`subStatus`	array	No	Filter, Default All，1-Pending｜2-Active｜3-Suspend \| 4-Cancel \| 5-Expire \| 6- Suspend\| 7-Incomplete \| 8-Processing \| 9-Failed
`subscriptionId`	string	No	Search Filter SubscriptionId
`userId`	integer	No	Filter UserId

Request examples

cURL

curl -X POST "https://api.unibee.dev/merchant/user/list" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "count": 0,
  "createTimeEnd": 0,
  "createTimeStart": 0,
  "deleteInclude": false,
  "email": "user@example.com",
  "externalUserId": "id_example",
  "firstName": "",
  "gatewayIds": [],
  "lastName": "",
  "page": 0,
  "planIds": [],
  "searchKey": "",
  "sortField": "",
  "sortType": "",
  "status": [],
  "subStatus": [],
  "subscriptionId": "id_example",
  "userId": 0
}'

Sandbox

curl -X POST "https://api-sandbox.unibee.top/merchant/user/list" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "count": 0,
  "createTimeEnd": 0,
  "createTimeStart": 0,
  "deleteInclude": false,
  "email": "user@example.com",
  "externalUserId": "id_example",
  "firstName": "",
  "gatewayIds": [],
  "lastName": "",
  "page": 0,
  "planIds": [],
  "searchKey": "",
  "sortField": "",
  "sortType": "",
  "status": [],
  "subStatus": [],
  "subscriptionId": "id_example",
  "userId": 0
}'

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.

Body

application/json

count

integer<int>

Count OF Page

createTimeEnd

integer<int64>

CreateTimeEnd，UTC timestamp，seconds

createTimeStart

integer<int64>

CreateTimeStart，UTC timestamp，seconds

deleteInclude

boolean<bool>

Deleted Involved，Need Admin

string<string>

Search Filter Email

externalUserId

string<string>

ExternalUserId

firstName

string<string>

Search FirstName

gatewayIds

integer<int64>[]

GatewayIds, Search Filter GatewayIds

lastName

string<string>

Search LastName

page

integer<int>

Page,Start 0

planIds

integer<int>[]

PlanIds, Search Filter PlanIds

searchKey

string<string>

sortField

string<string>

sortType

string<string>

Sort Type，asc|desc，Default desc

status

integer<int>[]

Status, 0-Active｜2-Frozen

subStatus

integer<int>[]

subscriptionId

string<string>

Search Filter SubscriptionId

userId

integer<int64>

Filter UserId

Response

200 - application/json

code

integer<int>

data

object

Show child attributes

merchantId

integer<int64>

message

string<string>

redirect

string<string>

requestId

string<string>

User List New User

Start Here

Core Concepts

Guides

Reference

Migration and Deployment

Endpoint Overview

Authorization

Parameters

Request body

Request examples

cURL

Sandbox

Response

Error handling

Authorizations

Body

Response

Start Here

Core Concepts

Guides

Reference

Migration and Deployment

Documentation Index

​Endpoint Overview

​Authorization

​Parameters

​Request body

​Request examples

​cURL

​Sandbox

​Response

​Error handling

Authorizations

Body

Response

Endpoint Overview

Authorization

Parameters

Request body

Request examples

cURL

Sandbox

Response

Error handling