Loading ...

REST API: Get Space Users | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Spaces » REST API: Get Space Users
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 3

REST API: Get Space Users

0 
 /5
0 (0votes)

Get Space Users

GET /api/spaces/{spaceid}/users

Get space users from database. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
Optional Parameters How to use Description
SpaceUserMembershipStatus &spaceUserMembershipStatus=x - Used in the request URL.

Specifies the membership status of the space user

  • Pending Approval = 0
  • Member = 1
RoleID &roleID=x - Used in the request URL.

 Specifies the role id of the role the space user have in the space
UserID

&userID=x - Used in the request URL

 Specifies the user id of the space user
SearchKeyWord &searchKeyWord=x - Used in the request URL

 Specifies the keywords for searching user in space.
IsProfilePublic &isProfilePublic=x - Used in the request URL

 Specifies profile visibility of the user.
StartPage

&startPage=x - Used in the request URL

 Specifies the starting page of list to be returned.
PageLength

&pageLength=x - Used in the request URL

 Specifies the number of results to be returned per page.

Example URL: https://your-community.com/api/spaces/3/users

Response JSON sample where space users JSON object is returned as ResponseData

Here is an example of JSON data returned from the API call.

{
 "IsError": false,
 "ResponseMessage": "",
 "ResponseData":
  {
   "AvatarImageURL": "https://your-community.com/assets/Themes/default/images/avatar-default.jpg",
   "AvatarPath": "avatar-default.jpg",
   "BlogID": 0,
   "DateFormat": "M/d/yyyy",
   "DateJoined": "2019-01-07T05:01:39.557",
   "DateJoinedString": "4 hours ago",
   "DateLastVisited": "2019-01-07T08:42:45.253",
   "DateLastVisitedString": "7 seconds ago",
   "Email": "aparna@axerosolutions.com",
   "EmailRecieve": 3,
   "SpaceDigestOption": 1,
   "FirstName": "Aparna",
   "FriendCategoryID": 0,
   "Gender": 0,
   "IP": "122.176.116.4",
   InvitationID": 0,
   "IsActivated": true,
   "IsAnonymous": false,
   "IsAvatarApproved": false,
   "IsBanned": false,
   "IsConfirmed": false,
   "IsContactInfoVisible": true,
   "IsFeatured": false,
   "IsIsolated": false,
   "IsProfileCompleted": true,
   "IsOptInPromotionalEmails": false,
   "IsPasswordEncrypted": true,
   "IsProfilePublic": true,
   "LastName": "Anand",
   "MediaServerID": 1,
   "MediaServerRootURL": "https://your-community.com/Assets/Uploaded-Photos",
   "MembershipStatus": 1,
   "MembershipType": 0,
   "MetaDescription": "{{USER_NAME}} is on {{COMMUNITY_NAME}}. Join {{COMMUNITY_NAME}} to connect with {{USER_NAME}}",
   "MetaKeywords": "Aparna, Anand",
   "MetaTitle": "{{USER_NAME}} | {{COMMUNITY_NAME}}",
   "NumBlogPosts": 0,
   "NumPosts": 0,
   "Occupation": "aa",
   "PMNotification": true,
   "Points": 5,
   "ProfileImageURL": "https://your-community.com/assets/Themes/default/images/profile-default.jpg",
   "ProfilePhoto": "profile-default.jpg",
   "ProfileURL": "https://your-community.com/people/aparna",
   "OnlineChatStatus": 1,
   "RankID": 1,
   "RankImage": "rank-lurker.gif",
   "RankImageURL": "https://your-community.com/Assets/Uploaded-Photos/rank-lurker.gif",
   "RankName": "Lurker",
   "RoleID": 0,
   "ShowEmail": true,
   "TimeFormat": "h:mm tt",
   "TimeZoneID": "India Standard Time",
   "UserID": 4,
   "UserInfoDisplayName": "Aparna Anand",
   "UserName": "aparna",
   "HasJoinedViaThirdPartyLogin": false,
   "IsWindowsADUser": false,
   "ChatStatusCssClass": "status-online",
   "ChatStatusText": "Online",
   "LastChatActivityDate": "2019-01-07T08:42:49.207",
   "UserPresenceStatus": 1,
   "FriendID": 0,
   "IsPasswordHashed": true,
   "AwardedContentCount": 0,
   "DirectReportCount": 0,
   "InOrgChart": false,
   "ConnectionStatus": 0,
   "CanChat": false,
   "TenantID": 0
  },
}

 

Please Note Your content type that you pass in the header of your request should be 'application/json'.

 

Wiki Index

Pages

Intranet Software