List Current Tenant Users
GET/openapi/v1/users/list| Item | Value |
|---|---|
| HTTP method | GET |
| Request path | /openapi/v1/users/list |
| Request type | query |
Request parameters:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | No | None | User email address, up to 128 characters. |
memberId | string | No | None | Member ID, up to 128 characters. |
externalId | string | No | None | User ID on the merchant side, up to 64 characters. |
kycStatus | string | No | None | KYC status: NOT_SUBMITTED, PENDING, PENDING_APPROVAL, APPROVED, REJECTED, MODIFY, or CERT_REQUIRED; case-insensitive. PENDING is equivalent to PENDING_APPROVAL. |
page | integer | No | 1 | Page number, starting at 1. |
pageSize | integer | No | 20 | Number of items per page, from 1 to 100. |
Response data
| Field | Type | Description |
|---|---|---|
items | array | List of users. |
items[].email | string | User email address. |
items[].memberId | string | Member ID. |
items[].externalId | string | User ID on the merchant side. |
items[].firstName | string | First name. |
items[].lastName | string | Last name. |
items[].kycStatus | string | KYC status: not_submitted, pending_approval, approved, rejected, modify, or cert_required. |
page | integer | Current page number. |
pageSize | integer | Number of items per page. |
total | integer | Total count. |
