Get Users
/user/ - Enhanced with Fast Accounting Data
Description
Description: The/user/ endpoint retrieves user data with optional accounting information from cached data.
Authorization:
- Required role:
adminor higher
accounting=true, this endpoint now provides:
- 95% faster performance: 10-50ms response vs previous 500-2000ms BigQuery approach
- Cached accounting data: Returns Gross, Paid, Due values from UserAccounting table
- Background processing: Automatically queues calculation for users without cached data
- Transparent operations: Response includes metadata about cache status and queued calculations
GET
Query Parameters:
- Without accounting: Standard user list response
- With accounting=true: Includes cached Gross, Paid, Due values with 95% faster performance
- Users without cache: Return zeros with
pendingCalculation: trueand get queued for background processing
Code Examples
Authorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Query Parameters
Search query to filter users
Page number for pagination
Number of users per page
Set to 'true' to include fast cached accounting data
true, false Comma-separated list of attributes to include in the response
Filter users by external ID
Filter by user role(s), comma-separated for multiple
Sort field. Unrecognised values fall back to updatedAt. Sorting by the accounting fields (gross, paid, due) is not supported — those values were previously documented but never implemented, and only ever produced an error.
createdAt, updatedAt, lastLogin, name, split this value determines the order for sorting the result, either ascending or descending
asc, desc Filter users by email presence. true = users with linked User account, false = users without
true, false Filter users by payment settings. true = users with payment method, false = users without
true, false Filter users by artist linkage. true = users linked to artists, false = users not linked
true, false