List users
curl --request GET \
--url https://api.qash.ai/api/v1/partner/users \
--header 'X-Api-Key: <api-key>' \
--header 'X-Api-Secret: <api-key>'const options = {
method: 'GET',
headers: {'X-Api-Key': '<api-key>', 'X-Api-Secret': '<api-key>'}
};
fetch('https://api.qash.ai/api/v1/partner/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.qash.ai/api/v1/partner/users"
headers = {
"X-Api-Key": "<api-key>",
"X-Api-Secret": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"data": {
"users": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"email": "user@example.com",
"status": "active",
"countryCode": "CO",
"createdAt": "2026-05-27T10:00:00.000Z"
}
],
"pagination": {
"total": 1,
"limit": 100,
"offset": 0,
"hasMore": false
}
}
}{
"success": false,
"error": "Number must be greater than or equal to 1"
}{
"success": false,
"error": "Invalid partner credentials"
}{
"success": false,
"error": "Failed to retrieve users"
}Users
List users
List all end-users registered under your partner API key, with filters and pagination.
GET
/
api
/
v1
/
partner
/
users
List users
curl --request GET \
--url https://api.qash.ai/api/v1/partner/users \
--header 'X-Api-Key: <api-key>' \
--header 'X-Api-Secret: <api-key>'const options = {
method: 'GET',
headers: {'X-Api-Key': '<api-key>', 'X-Api-Secret': '<api-key>'}
};
fetch('https://api.qash.ai/api/v1/partner/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.qash.ai/api/v1/partner/users"
headers = {
"X-Api-Key": "<api-key>",
"X-Api-Secret": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"data": {
"users": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"email": "user@example.com",
"status": "active",
"countryCode": "CO",
"createdAt": "2026-05-27T10:00:00.000Z"
}
],
"pagination": {
"total": 1,
"limit": 100,
"offset": 0,
"hasMore": false
}
}
}{
"success": false,
"error": "Number must be greater than or equal to 1"
}{
"success": false,
"error": "Invalid partner credentials"
}{
"success": false,
"error": "Failed to retrieve users"
}Requires
X-Api-Key and X-Api-Secret headers. See Authentication for details.offset by limit until hasMore is false:
offset=0, limit=20 → hasMore: true → continue
offset=20, limit=20 → hasMore: true → continue
offset=40, limit=20 → hasMore: false → done
Authorizations
Partner API key. Generated from Qash Dashboard → Settings → API Keys.
Partner API secret. Shown once at creation — store it securely.
Query Parameters
Filter by user status.
Available options:
pending, active, suspended, banned, kyc_required Number of records per page. Default: 20. Max: 200.
Required range:
1 <= x <= 200Number of records to skip. Default: 0.
Required range:
x >= 0Response
Users returned successfully.
Example:
true
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes