The user namespace provides a simple method to get the current, authenticated user. You can also use this method to test API access and authentication.
The users namespace provides API methods to retrieve all or specific users.
This method uses pagination so you might need to request additional pages to retrieve all users.
Request
"page": {"type":"integer","format":"int64","description":"Number of page (default: first page)."},"per_page": {"type":"integer","format":"int64","enum": [15,25,50,100 ],"description":"Maximum number of items to return per page (default: 100)."}
This method uses pagination so you might need to request additional pages to retrieve all users.
Request
"page": {"type":"integer","format":"int64","description":"Number of page (default: first page)."},"per_page": {"type":"integer","format":"int64","enum": [15,25,50,100 ],"description":"Maximum number of items to return per page (default: 100)."},"expands": {"type":"string","description":"Comma-separated list of expands to return."}
This method supports the following expands so you can automatically include additional information for referenced objects:
// Get first 100 usersGET/api/v1/users// Get second result page (pagination)GET/api/v1/users?page=2// Get users and include group & role detailsGET/api/v1/users?expands=groups,roles