List users
List the users under your account.
The rows arrive in data. Alongside them, pagination reports the total number of users matching your filters, plus the limit and offset applied to this page.
Use the query parameters to narrow the list — by status, type, email, verification_status, creation date, or metadata — and limit and offset to page through it.
Authorizations
The data.access_token value from Get access token.
Headers
Version applied to this request. It wins over your account's pinned version — see Versioning.
"2026-06-01"
Query Parameters
Filter by user status.
Available options: CREATED, VERIFYING, REVIEW, VERIFIED, REJECTED, plus the legacy ACTIVE, INACTIVE and SUSPENDED.
See User values for what each one means.
Filter by user type.
Available options: business, individual.
See User values for what each one means.
Filter by the user's verification result.
Available options: unverified, started, in_review, verified, rejected, needs_action.
See User values for what each one means.
Filter by the metadata you stored on the user.
Repeat the parameter once per key: ?metadata[order_id]=A-17&metadata[region]=eu. A user matches only if it carries every pair you send, each with exactly that value. Extra keys on the user do not prevent a match.
Keys are 1 to 40 characters and cannot contain [ or ]. Values are strings of up to 500 characters.