Skip to main content
GET
List users

Authorizations

Authorization
string
header
required

The data.access_token value from Get access token.

x-api-key
string
header
required

API key issued by Kira.

Headers

X-Api-Version
string

Version applied to this request. It wins over your account's pinned version — see Versioning.

Example:

"2026-04-14"

Query Parameters

limit
integer
default:10

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.

Required range: 1 <= x <= 100
offset
integer
default:0

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

Required range: x >= 0
status
string

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.

type
string

Filter by user type.

Available options: business, individual.

See User values for what each one means.

email
string

Substring match against the user's email.

verification_status
string

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.

created_after
string<date-time>

Return users created at or after this ISO 8601 date-time.

created_before
string<date-time>

Return users created at or before this ISO 8601 date-time.

metadata
object

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.

include_eligibility
boolean
default:false

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.

Response

Success.

data
object[]
pagination
object