Search and List Users
GET
/auth/admin/users
Deprecated OpenAPI path alias. Prefer GET /auth/users (runtime). Same filters as adminListUsers.
Authorizations
SessionAuth
Session ID for authenticated requests
Type
API Key (header: X-Session-ID)
Parameters
Query Parameters
q
Search query (email, name, username)
Type
string
userType
Filter by user type
Type
string
Example
"customer"page
Page number
Type
integer
Default
1limit
Items per page
Type
integer
Default
10is_business
Filter by business flag (requires ext-business)
Type
boolean
biz_country
Filter by ISO alpha-2 country (requires ext-business)
Type
string
Min Length
2Max Length
2privacy_region
Filter by privacy region (requires ext-privacy)
Type
string
Valid values
"eu""ca""eu_ca""global"Responses
Users list retrieved successfully
application/json
JSON "success": true, "data": { "users": [ { "id": "usr_abc123", "email": "user@example.com", "name": "John", "last_name": "Doe", "user_name": "johndoe", "user_type": "customer", "picture": "https://storage.pubflow.com/users/usr_abc123/picture.jpg", "phone": "+1234567890", "is_verified": true, "two_factor": false, "created_at": "2025-12-07T10:00:00Z", "updated_at": "2025-12-07T10:00:00Z", "first_time": true, "is_business": true, "biz_name": "string", "biz_country": "string", "biz_state": "string", "biz_position": "string", "gdpr_consent": true, "gdpr_consent_at": "string", "gdpr_consent_version": "string", "ccpa_applies": true, "ccpa_opt_out": true, "ccpa_opt_out_at": "string", "privacy_region": "string", "biz_postal_code": "string" } ], "pagination": { "page": 1, "limit": 20, "total": 150, "pages": 8 } }
{
}
Runtime path: GET /auth/users (admin / superadmin).
Optional onboarding filters: is_business, biz_country, privacy_region (require module columns; otherwise module_not_installed).
Related: Acquisition analytics · Business operations · Admin API