Get a list of users based on parameters. Valid for Communifire version 5.2 and above.
GET https://myintranet.communifire.com/api/users?IsActivated=true&SortColumn=1&SortOrder=0&StartPage=1&PageLength=15
User JSON object is returned as ResponseData. Note that some properties are removed from this sample to make it shorter.
{ "IsError":false, "ResponseMessage":"", "ResponseData": [ { "AIM":null, "AvatarImageURL":"http://myintranet.communifire.com/Assets/Uploaded-Photos/", "AvatarPath":null, "Bio":null, "CreatedBy":0, "CreatedUser":null, "DOB":null, "DOBString":null, "DateBanned":null, "DateFormat":null, "DateJoined":"0001-01-01T00:00:00", "DateJoinedString":null, "DateLastVisited":null, "DateLastVisitedString":null, "DefaultCulture":null, "Description":null, "Email":"acme@acme.com", "EmailRecieve":1, "SpaceDigestOption":0, "FacebookURL":null, "FavoriteBooks":null, "FavoriteCuisines":null, "FavoriteMusic":null, "FavoriteTVShows":null, "FaxNumber":null, "FirstName":"Jon", "Gender":null, "GoogleIM":null, "HomePage":null, "ICQIM":null, "IP":null, "Image":null, "ImageString":null, "Interests":null, "InvitationID":0, "IsActivated":false, "IsAnonymous":false, "IsAvatarApproved":false, "IsBanned":false, "IsConfirmed":false, "IsContactInfoVisible":true, "IsFeatured":false, "IsIsolated":false, "IsProfileCompleted":false, "IsOptInPromotionalEmails":false, "IsPasswordEncrypted":false, "IsProfilePublic":false, "LastName":"Smith", "LinkedinURL":null, "Location":"", "MSN":null, "MembershipStatus":0, "MembershipType":0, "MetaDescription":null, "MetaKeywords":null, "MetaTitle":null, "MiddleName":null, "NumBlogPosts":0, "NumPosts":0, "Occupation":null, "Password":null, "PhoneNumber":null, "Points":0, "ProfileImageURL":"http://myintranet.communifire.com/Assets/Uploaded-Photos/10-e481a169-e506-4023-93c1-756621add3b2.png", "ProfilePhoto":null, "ProfileURL":\"http://myintranet.communifire.com/people/jon", "OnlineChatStatus":null, "RankID":0, "RankImage":null, "RankImageURL":null, "RankName":null, "RequestMessage":null, "Role":null, "RoleID":0, "Roles":null, "Salutation":null, "ShowEmail":false, "Signature":null, "SkypeIM":null, "SpaceID":0, "StatusNow":null, "TimeFormat":null, "TimeZoneID":"India Standard Time", "TwitterURL":null, "UserID":1, "UserInfoDisplayName":"Jon Smith", "UserName":"jon", "YIM":null, "CRMUserContactID":null, "HasJoinedViaThirdPartyLogin":false, "ChatStatusCssClass":null, "ChatStatusText":null, "UserAddress":null }, { "AIM":null, "AvatarImageURL":"http://myintranet.communifire.com/Assets/Uploaded-Photos/", "AvatarPath":null, "Bio":null, "CreatedBy":0, "CreatedUser":null, "DOB":null, "DOBString":null, "DateBanned":null, "DateFormat":null, "DateJoined":"0001-01-01T00:00:00", "DateJoinedString":null, "DateLastVisited":null, "DateLastVisitedString":null, "DefaultCulture":null, "Description":null, "Email":"Ben@acme.com", "EmailRecieve":1, "SpaceDigestOption":0, "FacebookURL":null, "FavoriteBooks":null, "FavoriteCuisines":null, "FavoriteMusic":null, "FavoriteTVShows":null, "FaxNumber":null, "FirstName":"Ben", "Gender":null, "GoogleIM":null, "HomePage":null, "ICQIM":null, "IP":null, "Image":null, "ImageString":null, "Interests":null, "InvitationID":0, "IsActivated":false, "IsAnonymous":false, "IsAvatarApproved":false, "IsBanned":false, "IsConfirmed":false, "IsContactInfoVisible":true, "IsFeatured":false, "IsIsolated":false, "IsProfileCompleted":false, "IsOptInPromotionalEmails":false, "IsPasswordEncrypted":false, "IsProfilePublic":false, "LastName":"Lords", "LinkedinURL":null, "Location":"", "MSN":null, "MembershipStatus":0, "MembershipType":0, "MetaDescription":null, "MetaKeywords":null, "MetaTitle":null, "MiddleName":null, "NumBlogPosts":0, "NumPosts":0, "Occupation":null, "Password":null, "PhoneNumber":null, "Points":0, "ProfileImageURL":"http://myintranet.communifire.com/Assets/Uploaded-Photos/10-e481a169-e506-4023-93c1-756621add3b2.png", "ProfilePhoto":null, "ProfileURL":"http://myintranet.communifire.com/people/ben", "OnlineChatStatus":null, "RankID":0, "RankImage":null, "RankImageURL":null, "RankName":null, "RequestMessage":null, "Role":null, "RoleID":0, "Roles":null, "Salutation":null, "ShowEmail":false, "Signature":null, "SkypeIM":null, "SpaceID":0, "StatusNow":null, "TimeFormat":null, "TimeZoneID":"Central Standard Time", "TwitterURL":null, "UserID":3, "UserInfoDisplayName":"Ben Lords", "UserName":"ben", "YIM":null, "CRMUserContactID":null, "HasJoinedViaThirdPartyLogin":false, "ChatStatusCssClass":null, "ChatStatusText":null, "UserAddress":null, }, { "AIM":null, "AvatarImageURL":"http://myintranet.communifire.com/Assets/Uploaded-Photos/", "AvatarPath":null, "Bio":null, "CreatedBy":0, "CreatedUser":null, "DOB":null, "DOBString":null, "DateBanned":null, "DateFormat":"dd/MM/yy", "DateJoined":"2016-01-29T04:12:34.743", "DateJoinedString":"36 seconds ago", "DateLastVisited":"2016-01-29T04:12:34.743", "DateLastVisitedString":"36 seconds ago", "DefaultCulture":null, "Description":null, "Email":"maurice@huel.ca", "EmailRecieve":3, "FacebookURL":null, "FavoriteBooks":null, "FavoriteCuisines":null, "FavoriteMusic":null, "FavoriteTVShows":null, "FaxNumber":null, "FirstName":"Mike", "FriendCategoryID":0, "FriendCategoryName":null, "FriendID":0, "Gender":0, "GoogleIM":null, "HomePage":null, "ICQIM":null, "IP":"::1", "Image":null, "ImageString":null, "Interests":null, "InvitationID":0, "IsActivated":true, "IsAnonymous":false, "IsBanned":false, "IsConfirmed":false, "IsContactInfoVisible":true, "IsFeatured":false, "IsIsolated":false, "IsProfileCompleted":false, "IsOptInPromotionalEmails":false, "IsPasswordEncrypted":false, "IsProfilePublic":true, "LastName":"", "LinkedinURL":null, "Location":"", "MSN":null, "MembershipStatus":0, "MembershipType":0, "MetaDescription":"{{USER_NAME}} is on {{COMMUNITY_NAME}}. Join {{COMMUNITY_NAME}} to connect with {{USER_NAME}}", "MetaKeywords":null, "MetaTitle":"{{USER_NAME}} | {{COMMUNITY_NAME}}", "MiddleName":null, "NumBlogPosts":0, "NumPosts":0, "Occupation":null, "Password":null, "PhoneNumber":null, "Points":0, "ProfileImageURL":"http://myintranet.communifire.com/Assets/Uploaded-Photos/10-e481a169-e506-4023-93c1-756621add3b2.png", "ProfilePhoto":null, "ProfileURL":"http://myintranet.communifire.com/people/Mike", "OnlineChatStatus":1, "RankID":1, "RankImage":"rank-lurker.gif", "RankImageURL":\"http://myintranet.communifire.com/Assets/Uploaded-Photos/rank-lurker.gif", "RankName":"Lurker", "RequestMessage":null, "Role":"Member", "RoleID":3, "Roles":null, "Salutation":null, "ShowEmail":false, "Signature":null, "SkypeIM":null, "SpaceID":0, "StatusNow":null, "TimeFormat":"h:mm tt", "TimeZoneID":"UTC", "TwitterURL":null, "UserID":1311, "UserInfoDisplayName":"Mike", "UserName":"Mike", "YIM":null, "CRMUserContactID":null, "HasJoinedViaThirdPartyLogin":false, "ChatStatusCssClass":"status-offline", "ChatStatusText":"Offline", "UserAddress":null, } ] }
Please Note The content type that you pass in the header of your request should be application/json.
is requesting access to a wiki that you have locked: https://my.axerosolutions.com/spaces/5/communifire-documentation/wiki/view/409/rest-api-search-users-get-users?locale=en-US%2525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252f1%2525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252f1%2525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252f1%2525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252525252f1
Your session has expired. You are being logged out.