Skip to main content
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>'
{
  "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
    }
  }
}
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: 
offset=0,  limit=20 → hasMore: true  → continue
offset=20, limit=20 → hasMore: true  → continue
offset=40, limit=20 → hasMore: false → done

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