Loading ...

REST API: Get User Spaces | Communifire Documentation

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

REST API: Get User Spaces

0 
 /5
0 (0votes)

Get User Spaces

GET /api/spaces/me

Get a list of the logged in user's spaces. 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
StartPage &StartPage=x - Used in the request URL as a query parameter Specifies the starting page of list to be returned.
PageLength &PageLength=x - Used in the request URL as a query parameter Specifies the number of results to be returned per page.

Example Request

GET https://myintranet.communifire.com/api/spaces/me

Example Response

Space JSON object is returned as ResponseData.

{
 "IsError": false,
 "ResponseMessage": "",
 "ResponseData":
  {
    "SpaceURL": "https://myintranet.communifire.com/252/human-resources/hr-homepage",
    "SpaceName": "Human Resources",
    "SpaceImageURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files/SpacesFiles/252/931d24b3-e669-4151-ab2c-3159775730c7.jpg",
    "Description": "A space dedicated to all your human resources needs and questions.,
    "SpaceID": 252,
    "ParentSpaceID": 0,
    "IsFeatured": true,
    "Stub": "human-resources",
    "LandingPage": "https://myintranet.communifire.com/spaces/252/human-resources/hr-homepage",
    "TotalMembers": 104,
    "CreatedBy": 376,
    "UserID": 376,
    "UserName": "admin",
    "UserFirstName": "Alexis",
    "UserLastName": "Fox",
    "UserEmail": "test@axerosolutions.com",
    "StatusID": 1,
    "MembershipType": 1,
    "SpaceVisibility": 1,
    "DateCreated": "2017-07-04T08:05:31.37",
    "IsAttendee": false,
    "EventID": 0,
    "InviteSpaceID": 0,
    "WorkFlowID": 0,
    "CurrentWorkFlowStepID": 0,
    "IsArticleWorkflowActive": false,
    "IsBlogWorkflowActive": false,
    "IsEventWorkflowActive": false,
    "IsForumWorkflowActive": false,
    "IsWikiWorkflowActive": false,
    "IsFileWorkflowActive": false,
    "IsPhotoWorkFlowActive": false,
    "IsJobWorkflowActive": false,
    "IsVideoWorkFlowActive": false,
    "EnableForums": true,
    "EnableJobs": false,
    "EnableSurveys": true,
    "EnablePhotos": true,
    "EnableTaskManager": true,
    "EnableFiles": true,
    "EnableWiki": true,
    "EnableEvents": true,
    "EnableArticles": true,
    "EnableBlogs": true,
    "EnableVideos": true,
    "EnableIssueTracker": true,
    "EnableFileControl": false,
    "GroupPictureFileName": "931d24b3-e669-4151-ab2c-3159775730c7.jpg",
    "SpaceIconFileName": "931d24b3-e669-4151-ab2c-3159775730c7_icon.jpg",
    "SpaceIconURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files/SpacesFiles/252/931d24b3-e669-4151-ab2c-3159775730c7_icon.jpg",
    "MediaServerID": 24,
    "SpaceMediaServerRootURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files",
    "UserMediaServerRootURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos",
    "UserAvatarFileName": "f9c8486c-f3f3-41f9-9f46-044093247dc9.jpg",
    "UpdatedByUserID": 0,
    "InvitationExpiryInDays": 0,
    "DisableWallEmailNotifications": true,
    "AutoSubscribeEmail": true,
    "IsArticleCommentWorkflowActive": false,
    "IsBlogEntryCommentWorkflowActive": false,
    "IsEventCommentWorkflowActive": false,
    "IsForumPostWorkflowActive": false,
    "IsPhotoCommentWorkflowActive": false,
    "IsVideoCommentWorkflowActive": false,
    "IsWikiCommentWorkflowActive": false,
    "IsFileCommentWorkflowActive": false,
    "IsIdeaCommentWorkflowActive": false,
    "IsJobCommentWorkflowActive": false,
    "EnableUpcomingBirthdaysControl": true,
    "EnableContentReadConfirmation": true,
    "ManageSpaceURL": "https://myintranet.communifire.com/spaces/252/human-resources/manage/default",
    "SpaceVisibilityText": "Public Space",
    "HasManageSpacePerm": true,
    "AutoSubscribeForums": true,
    "EnableCalendarImportFromExternalSources": false,
    "EnableEventsFromOtherSpacesInCalendar": true,
    "EnableContentExpiration": true,
    "EnableTaskRating": true,
    "ActivityURL": "https://myintranet.communifire.com/spaces/252/human-resources/?act=1",
    "TenantID": 0
   },
   {
    "SpaceURL": "https://myintranet.communifire.com/spaces/255/internal-communications",
    "SpaceName": "Internal Communications",
    "SpaceImageURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files/SpacesFiles/255/83816c16-f571-4bd1-a2a5-3c95e1200c5b.png",
    "Description": "The space for accessing all of the company's internal communications",
    "SpaceID": 255,
    "ParentSpaceID": 0,
    "IsFeatured": true,
    "Stub": "internal-communications",
    "LandingPage": "",
    "TotalMembers": 1,
    "CreatedBy": 376,
    "UserID": 376,
    "UserFirstName": "Alexis",
    "UserLastName": "Fox",
    "UserEmail": "test@axerosolutions.com",
    "StatusID": 1,
    "MembershipType": 1,
    "SpaceVisibility": 1,
    "DateCreated": "2017-11-14T02:05:30.523",
    "IsAttendee": false,
    "EventID": 0,
    "InviteSpaceID": 0,
    "WorkFlowID": 0,
    "CurrentWorkFlowStepID": 0,
    "IsArticleWorkflowActive": false,
    "IsBlogWorkflowActive": false,
    "IsEventWorkflowActive": false,
    "IsForumWorkflowActive": false,
    "IsWikiWorkflowActive": false,
    "IsFileWorkflowActive": false,
    "IsPhotoWorkFlowActive": false,
    "IsJobWorkflowActive": false,
    "IsVideoWorkFlowActive": false,
    "EnableForums": true,
    "EnableJobs": false,
    "EnableSurveys": true,
    "EnablePhotos": true,
    "EnableTaskManager": true,
    "EnableFiles": true,
    "EnableWiki": true,
    "EnableEvents": true,
    "EnableArticles": true,
    "EnableBlogs": true,
    "EnableVideos": true,
    "EnableIssueTracker": true,
    "EnableFileControl": false,
    "GroupPictureFileName": "83816c16-f571-4bd1-a2a5-3c95e1200c5b.png",
    "SpaceIconFileName": "83816c16-f571-4bd1-a2a5-3c95e1200c5b_icon.png",
    "SpaceIconURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files/SpacesFiles/255/83816c16-f571-4bd1-a2a5-3c95e1200c5b_icon.png",
    "MediaServerID": 24,
    "SpaceMediaServerRootURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files",
    "UserMediaServerRootURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos",
    "UserAvatarFileName": "f9c8486c-f3f3-41f9-9f46-044093247dc9.jpg",
    "UpdatedByUserID": 0,
    "InvitationExpiryInDays": 0,
    "DisableWallEmailNotifications": false,
    "AutoSubscribeEmail": true,
    "IsArticleCommentWorkflowActive": false,
    "IsBlogEntryCommentWorkflowActive": false,
    "IsEventCommentWorkflowActive": false,
    "IsForumPostWorkflowActive": false,
    "IsPhotoCommentWorkflowActive": false,
    "IsVideoCommentWorkflowActive": false,
    "IsWikiCommentWorkflowActive": false,
    "IsFileCommentWorkflowActive": false,
    "IsIdeaCommentWorkflowActive": false,
    "IsJobCommentWorkflowActive": false,
    "EnableUpcomingBirthdaysControl": false,
    "EnableContentReadConfirmation": true,
    "HasManageSpacePerm": true,
    "AutoSubscribeForums": false,
    "EnableCalendarImportFromExternalSources": false,
    "EnableEventsFromOtherSpacesInCalendar": false,
    "EnableContentExpiration": false,
    "EnableTaskRating": false,
    "ActivityURL": "https://myintranet.communifire.com/spaces/255/internal-communications",
    "TenantID": 0
   }
}

 

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

Wiki Index

Pages

Intranet Software