Search and List Users
GET
/auth/admin/users
Search and list users with pagination and filtering. Requires admin or superadmin role.
Authorizations
SessionAuth
Session ID for authenticated requests
Type
API Key (header: X-Session-ID)
Parameters
Query Parameters
q
Search query (searches in email, name, username)
Type
string
userType
Filter by user type (can be any custom user type: customer, admin, superadmin, teacher, student, etc.)
Type
string
Example
"customer"page
Page number
Type
integer
Default
1limit
Items per page
Type
integer
Default
20sortBy
Sort field
Type
string
Default
"created_at"sortOrder
Sort order
Type
string
Valid values
"asc""desc"Default
"desc"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" } ], "pagination": { "page": 1, "limit": 20, "total": 150, "pages": 8 } }
{
}