Users API

Get a list of users

GET /api/users

Parameters

Name	Description
page	The selected page number of a paginated list of elements. Default is 1.
per_page	The number of elements to return per page. Default is 50.

Request

Headers

Host: example.org
Cookie: _session_id=SW5uVkdDNGNsOFhsUG9NK3IyVk9BdEZEV21YZmpKcmNEcHprN3pvbllSSUNjeEFmOHBRNnlKUUNReTlMMXJBR1hweEl4NW15RWdWQWdsOEFyUjJvUklhOW1LdXhVa0hmY3E2MnNwNk9Ca1ZLZkdQSDNEcWw3aTlOanhtZ3dFTzRVYmZLUlo2OTVwRldvMVQxNTQ0Q1dxQSt1cmxBZ2JucDhIWm5PRnBodk10Z3MxNVBudWtFMFcwWUFSV09lV1E3L0hTdUE2aEN6OHhjbVd2ejNwSXdUM2JRclkwQk9QaDluYXZLVkN1WUFHWVFUVTRVWUxEQm9DSmtWblVNRTBnTUlST3g0WGVvNFlEamtzZFg3T1IveFplRHlxVkdHa2c2d2pMRzZMMHNvM0pxa01iNkwweTlqVmhlNVo0WEpOQzE4MC9qNnBZNXRqaUpvbnJycFY1MTNRK3BON25NQUVIZ2JEUHFHUGIyeWlWdnI4TzVXYnZ4YkU1YkNuMzR0OU50SzNMS1BCYUZ3eCt4ZGszbEJMbUNqaW1vYTBjYUQxMnlCT0pibmVmUktxbz0tLXdXbktwMzM5QnhWNjlyV0hpYTN3b1E9PQ%3D%3D--739482f8e7549f5a5143612004ec4707fdb862d0

Route

GET /api/users

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
ETag: W/"4881b85b057b47a6ede92ddedeebd37e"
Last-Modified: Wed, 03 Apr 2019 22:10:30 GMT
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _session_id=YlV3aVgrWWd4QVI3SlFMMTNOOG9leDlPSVFvR295eFlkNDhHK3Zyc2doWUpMWEJ6TW9zeW5oVFM0NDFtTVhQWkxobjM0WW9KWWVVMzBmbEp5bVNza1VDU2VMY3VXNXFQdjFWYUZoVi9XbWg1R21reUlZeWxUVVhFVUVpdEtuQ3VPeFVnRjdpVzZXcVRvNnRNc0lwaExjd21zaGRYQ1JrVFJ1OFBlM3JWaSt0MVk4aFp5R0svRWxsNTRYb1d0TWdiZ1hwZk1wVTlLMEl5QVNIenBZQXRFOUtrRnlCRVhpWGVZUWo2VzhwZGFUbUs3Z1ZkbTBtUE9UODR0Q0NFYUl3dXIwanNRVW9WejViTkxjaU9BVUpQcUs4L081MUdKQmZLeXE2T0VNQ1hTVi94SkRhZFVYU2FvaDAxenBwVFQ5SVBPeHgrZ1FjcXpyeCtIekRHeWk3M0loZlZIdi9TREF2WUlCZHhKSXVuendZVE92V0pxVTZHNi8rMUN5OTM4aGZET2QwT0VPK3J5SGMxdzJNczlsWUFTNjVTVjMrZUpGdmp6Y1JBaU9jQXN3bnlPVUlIelBmNkFyZFZyM0EvbVlpcC0tYVJqVmxGKzMxSmRkSU1iZSthYmMvdz09--a482fd288ffaa417b68fbd7b43bc6dade5da5899; path=/; HttpOnly
X-Request-Id: ccb1c1be-6eb6-420e-9283-569597a4714f
X-Runtime: 0.085356
Content-Length: 7527

Status

200 OK

Body

{"response":[{"id":1000000,"username":"admin","first_name":"Admin_1","last_name":"AlphaSearch","image":{"original":"","icon":"","entity_type":"image","complete_json":true},"is_deleted":null,"auth_method":"internal","ldap_group_id":null,"user_type":"analytics_developer","entity_type":"user","using_default_image":false,"active_license":true,"is_siteadmin":false,"roles":["admin"],"email":"chorususer457721@alpinenow.com","title":"Chief Data Scientist","dept":"Corporation Corp., Inc.","notes":"One of our top performers","admin":true,"subscribed_to_emails":true,"tags":[],"deactivated_at":null,"complete_json":true},{"id":1000001,"username":"evil_admin","first_name":"Admin_2","last_name":"AlphaSearch","image":{"original":"","icon":"","entity_type":"image","complete_json":true},"is_deleted":null,"auth_method":"internal","ldap_group_id":null,"user_type":"analytics_developer","entity_type":"user","using_default_image":false,"active_license":true,"is_siteadmin":false,"roles":["admin"],"email":"chorususer940188@alpinenow.com","title":"Chief Data Scientist","dept":"Corporation Corp., Inc.","notes":"One of our top performers","admin":true,"subscribed_to_emails":true,"tags":[],"deactivated_at":null,"complete_json":true},{"id":1000002,"username":"default","first_name":"Chorus","last_name":"User","image":{"original":"","icon":"","entity_type":"image","complete_json":true},"is_deleted":null,"auth_method":"internal","ldap_group_id":null,"user_type":"analytics_developer","entity_type":"user","using_default_image":false,"active_license":true,"is_siteadmin":false,"roles":[],"email":"chorususer663230@alpinenow.com","title":"Chief Data Scientist","dept":"Corporation Corp., Inc.","notes":"One of our top performers","admin":false,"subscribed_to_emails":true,"tags":[],"deactivated_at":null,"complete_json":true},{"id":1000003,"username":"no_collaborators","first_name":"Chorus","last_name":"User","image":{"original":"","icon":"","entity_type":"image","complete_json":true},"is_deleted":null,"auth_method":"internal","ldap_group_id":null,"user_type":"analytics_developer","entity_type":"user","using_default_image":false,"active_license":true,"is_siteadmin":false,"roles":[],"email":"chorususer59692@alpinenow.com","title":"Chief Data Scientist","dept":"Corporation Corp., Inc.","notes":"One of our top performers","admin":false,"subscribed_to_emails":true,"tags":[],"deactivated_at":null,"complete_json":true},{"id":1000007,"username":"the_collaborator","first_name":"Chorus","last_name":"User","image":{"original":"","icon":"","entity_type":"image","complete_json":true},"is_deleted":null,"auth_method":"internal","ldap_group_id":null,"user_type":"analytics_developer","entity_type":"user","using_default_image":false,"active_license":true,"is_siteadmin":false,"roles":[],"email":"chorususer532853@alpinenow.com","title":"Chief Data Scientist","dept":"Corporation Corp., Inc.","notes":"One of our top performers","admin":false,"subscribed_to_emails":true,"tags":[],"deactivated_at":null,"complete_json":true},{"id":1000008,"username":"not_a_member","first_name":"Chorus","last_name":"User","image":{"original":"","icon":"","entity_type":"image","complete_json":true},"is_deleted":null,"auth_method":"internal","ldap_group_id":null,"user_type":"analytics_developer","entity_type":"user","using_default_image":false,"active_license":true,"is_siteadmin":false,"roles":[],"email":"chorususer125511@alpinenow.com","title":"Chief Data Scientist","dept":"Corporation Corp., Inc.","notes":"One of our top performers","admin":false,"subscribed_to_emails":true,"tags":[],"deactivated_at":null,"complete_json":true},{"id":1000009,"username":"restricted_user","first_name":"Chorus","last_name":"User","image":{"original":"","icon":"","entity_type":"image","complete_json":true},"is_deleted":null,"auth_method":"internal","ldap_group_id":null,"user_type":"analytics_developer","entity_type":"user","using_default_image":false,"active_license":true,"is_siteadmin":false,"roles":[],"email":"chorususer295771@alpinenow.com","title":"Chief Data Scientist","dept":"Corporation Corp., Inc.","notes":"One of our top performers","admin":false,"subscribed_to_emails":true,"tags":[],"deactivated_at":null,"complete_json":true},{"id":1000004,"username":"no_picture","first_name":"no_picture","last_name":"User","image":{"original":"","icon":"","entity_type":"image","complete_json":true},"is_deleted":null,"auth_method":"internal","ldap_group_id":null,"user_type":"analytics_developer","entity_type":"user","using_default_image":false,"active_license":true,"is_siteadmin":false,"roles":[],"email":"chorususer250078@alpinenow.com","title":"Chief Data Scientist","dept":"Corporation Corp., Inc.","notes":"One of our top performers","admin":false,"subscribed_to_emails":true,"tags":[],"deactivated_at":null,"complete_json":true},{"id":1000006,"username":"owner","first_name":"searchquery","last_name":"User_1","image":{"original":"/paperclip/users/images/001/000/006/original/User.png?1554329366","icon":"/paperclip/users/images/001/000/006/icon/User.png?1554329366","entity_type":"image","complete_json":true},"is_deleted":null,"auth_method":"internal","ldap_group_id":null,"user_type":"analytics_developer","entity_type":"user","using_default_image":false,"active_license":true,"is_siteadmin":false,"roles":["data_admin"],"email":"chorususer282295@alpinenow.com","title":"Chief Data Scientist","dept":"Corporation Corp., Inc.","notes":"One of our top performers","admin":false,"subscribed_to_emails":true,"tags":[],"deactivated_at":null,"complete_json":true},{"id":1000010,"username":"typeahead","first_name":"typeahead","last_name":"User","image":{"original":"","icon":"","entity_type":"image","complete_json":true},"is_deleted":null,"auth_method":"internal","ldap_group_id":null,"user_type":"analytics_developer","entity_type":"user","using_default_image":false,"active_license":true,"is_siteadmin":false,"roles":[],"email":"chorususer209597@alpinenow.com","title":"Chief Data Scientist","dept":"Corporation Corp., Inc.","notes":"One of our top performers","admin":false,"subscribed_to_emails":true,"tags":[],"deactivated_at":null,"complete_json":true},{"id":1000011,"username":"typeahead_too","first_name":"typeahead_too","last_name":"User","image":{"original":"","icon":"","entity_type":"image","complete_json":true},"is_deleted":null,"auth_method":"internal","ldap_group_id":null,"user_type":"analytics_developer","entity_type":"user","using_default_image":false,"active_license":true,"is_siteadmin":false,"roles":[],"email":"chorususer672184@alpinenow.com","title":"Chief Data Scientist","dept":"Corporation Corp., Inc.","notes":"One of our top performers","admin":false,"subscribed_to_emails":true,"tags":[],"deactivated_at":null,"complete_json":true},{"id":1000005,"username":"with_picture","first_name":"with_picture","last_name":"User","image":{"original":"/paperclip/users/images/001/000/005/original/User.png?1554329365","icon":"/paperclip/users/images/001/000/005/icon/User.png?1554329365","entity_type":"image","complete_json":true},"is_deleted":null,"auth_method":"internal","ldap_group_id":null,"user_type":"analytics_developer","entity_type":"user","using_default_image":false,"active_license":true,"is_siteadmin":false,"roles":[],"email":"chorususer378083@alpinenow.com","title":"Chief Data Scientist","dept":"Corporation Corp., Inc.","notes":"One of our top performers","admin":false,"subscribed_to_emails":true,"tags":[],"deactivated_at":null,"complete_json":true}],"pagination":{"page":1,"per_page":50,"records":12,"total":1}}