Skip to main content

List Users

Returns one page of users, newest first. search is a single free-text term matched against name, surname and email at once (case-insensitive substring, matched per field, so a full name only matches when it is stored in one field). Soft-deleted users are not listed. A search that matches nobody answers an empty page, not an error.

Rows have the same shape as Get User by ID. A user carries no address: addresses belong to wallets, read them with List User Wallets.

Required permission: user:view

Request​

GET /v2/users

Parameters​

NameTypeInDescription
pageintegerqueryRequired. Page number, starting at 1
per_pageintegerqueryRequired. Items per page, 1–100
searchstringqueryOptional. Free-text term matched against name, surname and email. Omit it to list every user

Headers​

NameDescription
AuthorizationRequired. Bearer <access_token>

Example​

curl --request GET \
--url '{{baseUrl}}/v2/users?page=1&per_page=10&search=durdu' \
--header 'Authorization: Bearer <access_token>'

Response​

{
"data": [
{
"id": "6a87455ad5f439809d488ac3",
"external_id": null,
"name": "Burkay",
"surname": "Durdu",
"email": "burkay.durdu@rudiq.com",
"identity_number": "11111111111",
"status": 0,
"created_at": "2026-08-21T09:14:02.511Z",
"kyc": null
}
],
"total": 1,
"page": 1,
"per_page": 10
}

Response Fields​

FieldTypeDescription
dataarrayThe users on this page. Empty array when nothing matches
data[].idstringUser ID
data[].external_idstring | nullOpaque identifier supplied at migration; null when none was given
data[].namestringFirst name; empty string when not stored
data[].surnamestringLast name; empty string when not stored
data[].emailstringEmail; empty string for users migrated with an external_id only
data[].identity_numberstringNational identity number; empty string when not stored
data[].statusinteger0 = active, 1 = inactive (set with Update User Status)
data[].created_atstringISO 8601 creation time
data[].kycnullAlways null. KYC is recorded per wallet: read it from Get User Wallet
totalintegerNumber of users matching the filter
pageintegerRequested page
per_pageintegerRequested page size

Errors​

StatusCodeDescription
40010015Validation failed (page / per_page missing or out of range) — see details

See Errors for the error format and common codes.