Skip to main content
GET
List users
Requires X-Api-Key and X-Api-Secret headers. See Authentication for details.
Only returns users created by your API key — you never see users from other partners. To iterate all pages, increment offset by limit until hasMore is false:

Authorizations

X-Api-Key
string
header
required

Partner API key. Generated from Qash Dashboard → Settings → API Keys.

X-Api-Secret
string
header
required

Partner API secret. Shown once at creation — store it securely.

Query Parameters

status
enum<string>

Filter by user status.

Available options:
pending,
active,
suspended,
banned,
kyc_required
limit
integer
default:20

Number of records per page. Default: 20. Max: 200.

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

Number of records to skip. Default: 0.

Required range: x >= 0

Response

Users returned successfully.

success
boolean
required
Example:

true

data
object
required