Skip to content

List Current Tenant Users

GET /openapi/v1/users/list
ItemValue
HTTP methodGET
Request path/openapi/v1/users/list
Request typequery

Request parameters:

FieldTypeRequiredDefaultDescription
emailstringNoNoneUser email address, up to 128 characters.
memberIdstringNoNoneMember ID, up to 128 characters.
externalIdstringNoNoneUser ID on the merchant side, up to 64 characters.
kycStatusstringNoNoneKYC status: NOT_SUBMITTED, PENDING, PENDING_APPROVAL, APPROVED, REJECTED, MODIFY, or CERT_REQUIRED; case-insensitive. PENDING is equivalent to PENDING_APPROVAL.
pageintegerNo1Page number, starting at 1.
pageSizeintegerNo20Number of items per page, from 1 to 100.

Response data

FieldTypeDescription
itemsarrayList of users.
items[].emailstringUser email address.
items[].memberIdstringMember ID.
items[].externalIdstringUser ID on the merchant side.
items[].firstNamestringFirst name.
items[].lastNamestringLast name.
items[].kycStatusstringKYC status: not_submitted, pending_approval, approved, rejected, modify, or cert_required.
pageintegerCurrent page number.
pageSizeintegerNumber of items per page.
totalintegerTotal count.