List / search users

GET /users

Returns tenant users, optionally filtered by email or wallet address, with pagination.

Parameters

x-tenant-id string Required header

Tenant identifier. Required on all tenant-scoped routes.

More parameters Expand all

offset number query

Number of records to skip

limit number query

Max number of records to return

xrplSecureAccountAddress string query

Filter by XRPL secure account address

evmEoa string query

Filter by EVM/ZIG wallet address

email string query

Filter by exact user email

curl -X GET "https://heimdall.qa.zoniqx.com/users?offset=%3Cvalue%3E&limit=%3Cvalue%3E&xrplSecureAccountAddress=%3Cvalue%3E" \ -H "Authorization: Bearer <accessToken>" \ -H "x-tenant-id: <your-tenant-id>"

const response = await fetch("https://heimdall.qa.zoniqx.com/users?offset=%3Cvalue%3E&limit=%3Cvalue%3E&xrplSecureAccountAddress=%3Cvalue%3E", { method: "GET", headers: { "Authorization": "Bearer <accessToken>", "x-tenant-id": "<your-tenant-id>", }, }); const data = await response.json();

type UsersController_findAllResponse = Record<string, unknown>; const response = await fetch("https://heimdall.qa.zoniqx.com/users?offset=%3Cvalue%3E&limit=%3Cvalue%3E&xrplSecureAccountAddress=%3Cvalue%3E", { method: "GET", headers: { Authorization: "Bearer <accessToken>", "x-tenant-id": "<your-tenant-id>", }, }); const data: UsersController_findAllResponse = await response.json();

import requests url = "https://heimdall.qa.zoniqx.com/users" headers = { "Authorization": "Bearer <accessToken>", "x-tenant-id": "<your-tenant-id>", } params = { "offset": "<value>", "limit": "<value>", "xrplSecureAccountAddress": "<value>", } response = requests.get(url, headers=headers, params=params) data = response.json()

[ { "id": "string", "tenantId": "string", "userType": "person", "fullName": "string", "email": "user@example.com", "phoneNumber": "string", "currentAddressId": "string", "currentKycId": "string", "currentKybId": "string", "currentAccreditationId": "string", "digitalSignatureFileId": "string", "dateOfBirth": "string", "metadata": {}, "createdAt": "2024-01-15T10:30:00Z", "updatedAt": "2024-01-15T10:30:00Z", "currentAddress": {}, "currentAccreditation": {}, "currentKyc": {}, "currentKyb": {}, "evmEoas": [ { "address": "string", "createdAt": "2024-01-15T10:30:00Z" } ], "xrplSecureAccounts": [ {} ], "authMethods": [ { "createdAt": "2024-01-15T10:30:00Z", "identifier": "string", "type": "string", "authVendorData": {} } ] } ]