Export users as CSV
Exports users as a CSV file (up to 500 per page). Requires HR_TENANT permission for full export, or HR_LOCAL with a localCenter filter parameter for scoped export. Logs the export action for audit. Supports the same filters as the standard user list endpoint. Returns text/csv content type.
Authorizations
Server-to-server authentication. Generate a token in the admin UI at
Settings → Developers → API Access. Send the raw token in the
Api-Token header — there is no Bearer prefix.
Tokens can be marked read-only at creation time, in which case the API
rejects any non-GET request with 403 Forbidden.
Query Parameters
The collection page number
The number of items per page
0 <= x <= 500Enable or disable pagination
asc, desc asc, desc asc, desc asc, desc asc, desc asc, desc asc, desc asc, desc asc, desc asc, desc asc, desc asc, desc asc, desc Northern latitude boundary (requires south, east, west)
Southern latitude boundary (requires north, east, west)
Eastern longitude boundary (requires north, south, west)
Western longitude boundary (requires north, south, east)
Filter users by cluster latitude (requires clusterLng and clusterPrecision)
Filter users by cluster longitude (requires clusterLat and clusterPrecision)
Cluster precision (decimal places for rounding)
Filter by fee payment status: "paid", "not_paid", or "grace_period"
Filter users who are paid members or have any permission
Response
User collection
255255
