Loading ...

REST API: Get Administrators and Moderators | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: Get Administrators and Moderators
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 1

REST API: Get Administrators and Moderators

0 
 /5
0 (0votes)

Get Administrators and Moderators

GET /api/users/adminmoderators

Get a list of all users with the top level Site Administrator and Moderator roles or space Administrator and Moderator roles. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 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.
SpaceID &SpaceID=x - Used in the request URL as a query parameter ID of the space from which the administrators and moderators are to be returned.

Example Request

GET https://myintranet.communifire.com/api/users/adminmoderators?SpaceID=0

Example Response

User JSON object is returned as ResponseData. Note that some properties are removed from this sample to make it shorter.

{
    "IsError": false,
    "ResponseMessage": "",
    "ResponseData": [
        {
            "AvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/376/f9c8486c-f3f3-41f9-9f46-044093247dc9.jpg",
            "AvatarPath": "f9c8486c-f3f3-41f9-9f46-044093247dc9.jpg",
            "Bio": "<p>I'm excited to be able to help people achieve their potential in life, both at work and outside of the office.</p>",
            "BlogID": 0,
            "DOB": "1982-04-24T00:00:00",
            "DateFormat": "M/d/yyyy",
            "DateJoined": "2017-07-03T19:54:58.27",
            "DateJoinedString": "7/4/2017",
            "DateLastVisited": "2020-09-14T15:00:43.753",
            "DateLastVisitedString": "7 days ago",
            "Email": "alexis.fox@axerosolutions.com",
            "EmailRecieve": 3,
            "SpaceDigestOption": 1,
            "FacebookURL": "https://www.facebook.com/axerosolutions/",
            "FavoriteBooks": "<p>My books</p>",
            "FavoriteCuisines": "<p>Japanese, Chinese, Thai, Hamburgers, French Fries, Ice Cream, Lollipops, Hershey bars, Cheese.</p>",
            "FavoriteMusic": "<p>Air, Led Zeppelin, Miles Davis, The Doors, Nine Inch Nails, techno.</p>",
            "FavoriteTVShows": "<p>Dexter, Breaking Bad, X-Files, The Office.</p>",
            "FaxNumber": "444-333-5441",
            "FirstName": "Alexis",
            "Gender": 3,
            "GoogleIM": "alexisgoogle",
            "CompanyName": "Axero Solutions",
            "ICQIM": "Axero Solutions",
            "IP": "122.160.157.8",
            "Interests": "<p>Human Resources, helping people, business, employee engagement, intranet software.</p>",
            "InvitationID": 0,
            "IsActivated": true,
            "IsAnonymous": false,
            "IsUserLocked": false,
            "IsBanned": false,
            "IsConfirmed": false,
            "IsContactInfoVisible": true,
            "IsFeatured": true,
            "IsIsolated": false,
            "IsProfileCompleted": true,
            "IsOptInPromotionalEmails": false,
            "IsPasswordEncrypted": true,
            "IsProfilePublic": true,
            "LastName": "Fox",
            "LinkedinURL": "https://www.linkedin.com/company/axero-solutions-llc",
            "Location": "San Diego, California United States",
            "MediaServerID": 58,
            "MediaServerRootURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos",
            "MembershipStatus": 1,
            "MetaDescription": "{{USER_NAME}} is on {{COMMUNITY_NAME}}. Join {{COMMUNITY_NAME}} to connect with {{USER_NAME}}",
            "MetaKeywords": "admin, ",
            "MetaTitle": "{{USER_NAME}} | {{COMMUNITY_NAME}}",
            "MiddleName": "Remmington",
            "NumBlogPosts": 0,
            "NumPosts": 18,
            "Occupation": "CEO",
            "PMNotification": true,
            "PhoneNumber": "444-333-5445",
            "Points": 12165,
            "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/376/81085e30-ef6c-4928-a014-53fe56bc48a2.jpg",
            "ProfilePhoto": "81085e30-ef6c-4928-a014-53fe56bc48a2.jpg",
            "ProfileURL": "https://myintranet.communifire.com/people/admin",
            "OnlineChatStatus": 1,
            "RankID": 5,
            "RankImage": "rank-guru.gif",
            "RankImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/rank-guru.gif",
            "RankName": "Guru",
            "RoleID": 0,
            "Salutation": "607",
            "ShowEmail": true,
            "Signature": "",
            "SkypeIM": "alexisskype",
            "TimeFormat": "h:mm tt",
            "TimeZoneID": "Pacific Standard Time",
            "TwitterURL": "https://twitter.com/AxeroSolutions",
            "UserID": 376,
            "UserInfoDisplayName": "Alexis Fox",
            "UserName": "admin",
            "HasJoinedViaThirdPartyLogin": false,
            "IsWindowsADUser": false,
            "ChatStatusCssClass": "status-online",
            "ChatStatusText": "Online",
            "LastChatActivityDate": "2020-09-25T17:10:05.05",
            "UserPresenceStatus": 1,
            "SimpleFields": {
            },
            "IsPasswordHashed": true,
            "DirectReportCount": 5,
            "InOrgChart": true,
            "Industry": "1227",
            "ConnectionStatus": 0,
            "CanChat": false,
            "SpaceIDs": [
                252,
                255,
                256,
                257,
                258,
                262,
                278,
                279
            ],
            "RoleIDsTLC": [
                1,
                2,
                3
            ],
            "ContentMemberships": [
                1781,
                7076
            ],
            "TenantID": 0
        },
        {
            "AvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/612/265e840e-7cbf-404c-8411-18c4a1bbe303.jpg",
            "AvatarPath": "265e840e-7cbf-404c-8411-18c4a1bbe303.jpg",
            "BlogID": 0,
            "DateFormat": "M/d/yyyy",
            "DateJoined": "2017-10-31T05:45:08.02",
            "DateJoinedString": "10/30/2017",
            "DateLastVisited": "2020-07-30T17:10:07.627",
            "DateLastVisitedString": "7/30/2020",
            "Email": "user1328@axerosolutions.com",
            "EmailRecieve": 3,
            "SpaceDigestOption": 1,
            "FirstName": "Laura",
            "Gender": 0,
            "IP": "76.172.84.194",
            "InvitationID": 0,
            "IsActivated": true,
            "IsAnonymous": false,
            "IsUserLocked": false,
            "IsBanned": false,
            "IsConfirmed": false,
            "IsContactInfoVisible": true,
            "IsFeatured": true,
            "IsIsolated": false,
            "IsProfileCompleted": true,
            "IsOptInPromotionalEmails": false,
            "IsPasswordEncrypted": true,
            "IsProfilePublic": true,
            "LastName": "Carter",
            "MediaServerID": 58,
            "MediaServerRootURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos",
            "MembershipStatus": 0,
            "MetaDescription": "{{USER_NAME}} is on {{COMMUNITY_NAME}}. Join {{COMMUNITY_NAME}} to connect with {{USER_NAME}}",
            "MetaKeywords": "user1328, ",
            "MetaTitle": "{{USER_NAME}} | {{COMMUNITY_NAME}}",
            "NumBlogPosts": 0,
            "NumPosts": 2,
            "Occupation": "Recruiter",
            "PMNotification": false,
            "Password": "",
            "Points": 3049,
            "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/612/6a701198-309f-466e-80f1-4f181bfab64c.jpg",
            "ProfilePhoto": "6a701198-309f-466e-80f1-4f181bfab64c.jpg",
            "ProfileURL": "https://myintranet.communifire.com/people/laura",
            "OnlineChatStatus": 1,
            "RankID": 4,
            "RankImage": "rank-professional.gif",
            "RankImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/rank-professional.gif",
            "RankName": "Professional",
            "RoleID": 0,
            "ShowEmail": true,
            "TimeFormat": "h:mm tt",
            "TimeZoneID": "Pacific Standard Time",
            "UserID": 612,
            "UserInfoDisplayName": "Laura Carter",
            "UserName": "laura",
            "HasJoinedViaThirdPartyLogin": false,
            "IsWindowsADUser": false,
            "ChatStatusCssClass": "status-offline",
            "ChatStatusText": "Offline",
            "LastChatActivityDate": "2020-07-30T17:10:06.737",
            "UserPresenceStatus": 3,
            "SimpleFields": {
            },
            "IsPasswordHashed": true,
            "SupervisorID": 603,
            "DirectReportCount": 0,
            "InOrgChart": true,
            "ConnectionStatus": 0,
            "CanChat": false,
            "SpaceIDs": [
                252,
                255,
                257,
                262
            ],
            "RoleIDsTLC": [
             3
            ],
            "ContentMemberships": [
                1781,
                7076
            ],
            "TenantID": 1
        }
    ]
}

 


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

 

Wiki Index

Pages

Intranet Software