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.
Headers
Version applied to this request. It wins over your account's pinned version — see Versioning.
"2026-04-14"
Query Parameters
How many users to return. Between 1 and 100, and 10 when you omit it.
A value outside that range is rejected with a 400.
1 <= x <= 100How many users to skip before the first row returned. Use it with limit to walk the list: offset=0, then offset=10, and so on. 0 when you omit it.
x >= 0Filter 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.
Substring match against the user's email.
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.
Return users created at or after this ISO 8601 date-time.
Return users created at or before this ISO 8601 date-time.
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.
Set this to true to add capabilities.requested_banks and eligible_products to every row.
It is false by default. Those two fields are worked out per user, so asking for them makes the response slower and larger — request them only when you need them.