🚀 VaultsPay API v1 is live. See what's new →
UsersList Users

List Users

Returns a paginated list of users under your account.

GET/v1/users

Query parameters

FieldTypeDescription
limitintegerMax 100. Default 25.
cursorstringCursor from a previous response.
statusenumFilter by active | suspended | deleted.
kyc_statusenumFilter by pending | approved | rejected.
emailstringFilter by exact email match.
created_afterISO 8601Return users created after this time.
created_beforeISO 8601Return users created before this time.

Request

curl "https://api.vaultspay.ae/v1/users?limit=20&kyc_status=approved" \
  -H "Authorization: Bearer sk_test_yourApiKeyHere"

Response

200 OK
{
  "object": "list",
  "data": [
    { "id": "usr_01HX7...", "email": "ali@example.com", ... },
    { "id": "usr_02HZK...", "email": "layla@example.com", ... }
  ],
  "has_more": true,
  "next_cursor": "usr_02HZK..."
}

See Pagination for details on iterating all pages.