Loading ...

REST API: Get Filtered List of Users | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: Get Filtered List of Users
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 2

REST API: Get Filtered List of Users

0 
 /5
0 (0votes)

Get Filtered List of Users

GET /api/users

Get a list of users filtered by profile fields. Valid for Communifire version 8.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
8.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.
Filters &Filters=x - Used in the request URL as a query parameter

A comma-separated list of profile field IDs and field values. Use the following format:
fieldID:fieldValue,fieldID:fieldValue

For Picklist Fields , pass the OptionID as the field value. Use REST API: Get Profile Fields to get the OptionID

For username, use -2 as the field ID.
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/users?Filters=78:Axero Solutions,79:28&Startpage=1&PageLength=2

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": [
    {
      "IDProperty": "15-376",
      "Title": "Alexis Fox",
      "Summary": "I'm excited to be able to help people achieve their potential in life, both at work and outside of the office.",
      "SimpleFields": [
        {
          "FieldUseID": 9,
          "DataIDs": [
            4034
          ],
          "RenderedValue": "<a href='mailto:noreply@axerosolutions.com' title='noreply@axerosolutions.com'>noreply@axerosolutions.com</a>",
          "RenderedValues": [
            "<a href='mailto:noreply@axerosolutions.com' title='noreply@axerosolutions.com'>noreply@axerosolutions.com</a>"
          ],
          "FieldUTCDates": [],
          "LookupValues": [],
          "FieldValues": [
            "noreply@axerosolutions.com"
          ],
          "FieldValue2": "",
          "FieldValues2": [],
          "OptionResourceKeys": [],
          "ChildFields": {},
          "Indexed": false,
          "IsPreference": false,
          "SystemName": "SystemEmail",
          "FieldType": 1,
          "FieldSubType": 2,
          "RenderedValueES": "noreply@axerosolutions.com",
          "SortableFieldValue": "noreply@axerosolutions.com",
          "TenantID": 0
        },
        {
          "FieldUseID": 63,
          "DataIDs": [
            4035
          ],
          "RenderedValue": "Alexis",
          "RenderedValues": [
            "Alexis"
          ],
          "FieldUTCDates": [],
          "LookupValues": [],
          "FieldValues": [
            "Alexis"
          ],
          "FieldValue2": "",
          "FieldValues2": [],
          "OptionResourceKeys": [],
          "ChildFields": {},
          "Indexed": true,
          "IsPreference": false,
          "SystemName": "FirstName",
          "FieldType": 1,
          "FieldSubType": 1,
          "RenderedValueES": "Alexis",
          "SortableFieldValue": "Alexis",
          "TenantID": 0
        },
        {
          "FieldUseID": 64,
          "DataIDs": [
            4036
          ],
          "RenderedValue": "Fox",
          "RenderedValues": [
            "Fox"
          ],
          "FieldUTCDates": [],
          "LookupValues": [],
          "FieldValues": [
            "Fox"
          ],
          "FieldValue2": "",
          "FieldValues2": [],
          "OptionResourceKeys": [],
          "ChildFields": {},
          "Indexed": true,
          "IsPreference": false,
          "SystemName": "LastName",
          "FieldType": 1,
          "FieldSubType": 1,
          "RenderedValueES": "Fox",
          "SortableFieldValue": "Fox",
          "TenantID": 0
        }
      ],
      "SimpleFieldJson": "[{\"FieldUseID\":9,\"DataIDs\":[4034],\"RenderedValue\":\"<a href='mailto:noreply@axerosolutions.com' title='noreply@axerosolutions.com'>noreply@axerosolutions.com</a>\",\"RenderedValues\":[\"<a href='mailto:noreply@axerosolutions.com' title='noreply@axerosolutions.com'>noreply@axerosolutions.com</a>\"],\"FieldUTCDate\":null,\"FieldUTCDates\":[],\"LookupValue\":null,\"LookupValues\":[],\"FieldValues\":[\"noreply@axerosolutions.com\"],\"FieldValue2\":\"\",\"FieldValues2\":[],\"OptionResourceKeys\":[],\"ChildFields\":{},\"LookupValueContentTypes\":null,\"Indexed\":false,\"IsPreference\":false,\"SystemName\":\"SystemEmail\",\"FieldType\":1,\"FieldSubType\":2,\"RenderedValueES\":\"noreply@axerosolutions.com\",\"SortableFieldValue\":\"noreply@axerosolutions.com\",\"TenantID\":0},{\"FieldUseID\":63,\"DataIDs\":[4035],\"RenderedValue\":\"Alexis\",\"RenderedValues\":[\"Alexis\"],\"FieldUTCDate\":null,\"FieldUTCDates\":[],\"LookupValue\":null,\"LookupValues\":[],\"FieldValues\":[\"Alexis\"],\"FieldValue2\":\"\",\"FieldValues2\":[],\"OptionResourceKeys\":[],\"ChildFields\":{},\"LookupValueContentTypes\":null,\"Indexed\":true,\"IsPreference\":false,......}]",
      "FilterFields": [
        {
          "_fieldValues": [
            "noreply@axerosolutions.com"
          ],
          "<FieldUseID>k__BackingField": 9,
          "<FieldValueFiltered>k__BackingField": "lessthana href=apostrophemailtocolonnoreplyataxerosolutionsdotcomapostrophe title=apostrophenoreplyataxerosolutionsdotcomapostrophegreaterthannoreplyataxerosolutionsdotcomlessthanforwardslashagreaterthan",
          "<FieldValueSpecialCharsStripped>k__BackingField": " a href= mailto noreply axerosolutions com  title= noreply axerosolutions com  noreply axerosolutions com  a "
        },
        {
          "_fieldValues": [
            "Alexis"
          ],
          "<FieldUseID>k__BackingField": 63,
          "<FieldValueFiltered>k__BackingField": "Alexis",
          "<FieldValueSpecialCharsStripped>k__BackingField": "Alexis"
        },
        {
          "_fieldValues": [
            "Fox"
          ],
          "<FieldUseID>k__BackingField": 64,
          "<FieldValueFiltered>k__BackingField": "Fox",
          "<FieldValueSpecialCharsStripped>k__BackingField": "Fox"
        }
      ],
      "IndexedFieldValuesFiltered": "Alexis Fox Remmington Iapostrophem excited to be able to help people achieve their potential in life, both at work and outside of the officedot Axero Solutions CEO Human Resources, helping people, business, employee engagement, intranet software 123 West End Ave Suite 123 San Diego 92121 httpscolonforwardslashforwardslashmyintranetcommunifiredotcomforwardslashAssetsforwardslashUploadedhyphenPhotosforwardslash376forwardslash23cec306hyphen5e00hyphen4cfbhyphen9b49hyphen0d62e0ba5834dotjpg Human Resources ABCuscoreDEF Leadership Communications leading Comms",
      "IndexedFieldValuesSpecialCharsStripped": "Alexis Fox Remmington I m excited to be able to help people achieve their potential in life, both at work and outside of the office  Axero Solutions CEO Human Resources, helping people, business, employee engagement, intranet software 123 West End Ave Suite 123 San Diego 92121 https   myintranet communifire com Assets Uploaded Photos 376 23cec306 5e00 4cfb 9b49 0d62e0ba5834 jpg Human Resources ABC DEF Leadership Communications leading Comms",
      "IsIsolated": false,
      "UserFirstName": "Alexis",
      "UserLastName": "Fox",
      "UserEmail": "noreply@axerosolutions.com",
      "UserName": "admin",
      "UserNameFilterAppliedWithSpecialCharactersStripped": "admin",
      "UserSignature": "",
      "WallPostToUserID": 0,
      "PermissionCheckAuthorID": 376,
      "DateCreated": "2017-07-03T19:54:58.27",
      "DatePublished": "2017-07-03T19:54:58.27",
      "DateUpdated": "0001-01-01T00:00:00",
      "ShowDate": true,
      "ShowMetaData": true,
      "DateCreatedString": "7/3/2017",
      "DatePublishedString": "7/3/2017",
      "AuthorUserID": 376,
      "AuthorUsername": "admin",
      "AuthorUserDisplayName": "Alexis Fox",
      "AuthorUserAvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/376/12122f08-b586-416a-8d08-b99e9e45832a.jpeg",
      "AuthorUserProfileURL": "https://myintranet.communifire.com/people/admin",
      "SpaceID": 0,
      "ContentStatusID": 0,
      "ContentCurrentWorkFlowStepID": 0,
      "EntityType": 15,
      "EntityTypeText": "User",
      "ContentID": 376,
      "ContentURL": "/people/admin",
      "ContentImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/376/12122f08-b586-416a-8d08-b99e9e45832a.jpeg",
      "ContentMediaServerID": 42,
      "WallID": 0,
      "ContentStub": "admin",
      "GreatGrandParentContentID": 0,
      "ForumPostForumID": 0,
      "ForumPostTopicID": 0,
      "EntityIconCssClass": "icon-user",
      "IsExternalContent": false,
      "ParentEntityType": 0,
      "ParentContentID": 0,
      "ContentDetailImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/376/43e56923-e7c8-4089-beac-4763dfad07cd.jpeg",
      "ContentFeaturedImage": "f9c8486c-f3f3-41f9-9f46-044093247dc9.jpg",
      "UserIsProfilePublic": true,
      "UserIsActivated": true,
      "CommentCount": 0,
      "LikeCount": 0,
      "PageViews": 0,
      "Rating": 0.0,
      "IsComment": false,
      "IsSpaceLevel": false,
      "IsFeatured": true,
      "IsLatest": false,
      "IsContentPubliclyAccessible": false,
      "IsAddedFromActivityStream": false,
      "ShowRating": true,
      "ShowViewCount": true,
      "ShowCommentCount": true,
      "EventStartDate": "0001-01-01T00:00:00",
      "IsRecurringTime": false,
      "EventEndDate": "0001-01-01T00:00:00",
      "EventScheduleStartDate": "0001-01-01T00:00:00",
      "EventScheduleEndDate": "0001-01-01T00:00:00",
      "EventCountryID": 0,
      "EventStateID": 0,
      "EventMetroID": 0,
      "EventIsAllDay": false,
      "EventIsPrivate": false,
      "EventTypeID": 0,
      "SpaceVisibility": 0,
      "TotalChildRecords": 0,
      "RankName": "Guru",
      "RankImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/rank-guru.gif",
      "ChatStatusText": "Offline",
      "ChatStatusCSSClass": "status-offline",
      "SpaceIDs": [
        "252",
        "255",
        "256",
        "257",
        "258",
        "262",
        "279"
      ],
      "AwardID": 0,
      "MembershipContentID": 0,
      "ConnectedToUser": false,
      "IssueCommentIsProjectActive": false,
      "IssueCommentIsInternal": false,
      "IssueCommentIssueID": 0,
      "ActivityActionEnum": 0,
      "ActivityLogBrowserType": 0,
      "ActivityLogOperatingSys": 0,
      "ActivityLogUserID": 0,
      "IndexedContentType": 3
    },
    {
      "IDProperty": "15-602",
      "Title": "Alice Romero",
      "Summary": "",
      "SimpleFields": [
        {
          "FieldUseID": 9,
          "DataIDs": [
            7325
          ],
          "RenderedValue": "<a href='mailto:user1318@axerosolutions.com' title='user1318@axerosolutions.com'>user1318@axerosolutions.com</a>",
          "RenderedValues": [
            "<a href='mailto:user1318@axerosolutions.com' title='user1318@axerosolutions.com'>user1318@axerosolutions.com</a>"
          ],
          "FieldUTCDates": [],
          "LookupValues": [],
          "FieldValues": [
            "user1318@axerosolutions.com"
          ],
          "FieldValue2": "",
          "FieldValues2": [],
          "OptionResourceKeys": [],
          "ChildFields": {},
          "Indexed": false,
          "IsPreference": false,
          "SystemName": "SystemEmail",
          "FieldType": 1,
          "FieldSubType": 2,
          "RenderedValueES": "user1318@axerosolutions.com",
          "SortableFieldValue": "user1318@axerosolutions.com",
          "TenantID": 0
        },
        {
          "FieldUseID": 63,
          "DataIDs": [
            7326
          ],
          "RenderedValue": "Alice",
          "RenderedValues": [
            "Alice"
          ],
          "FieldUTCDates": [],
          "LookupValues": [],
          "FieldValues": [
            "Alice"
          ],
          "FieldValue2": "",
          "FieldValues2": [],
          "OptionResourceKeys": [],
          "ChildFields": {},
          "Indexed": true,
          "IsPreference": false,
          "SystemName": "FirstName",
          "FieldType": 1,
          "FieldSubType": 1,
          "RenderedValueES": "Alice",
          "SortableFieldValue": "Alice",
          "TenantID": 0
        }
      ],
      "SimpleFieldJson": "[{\"FieldUseID\":9,\"DataIDs\":[7325],\"RenderedValue\":\"<a href='mailto:user1318@axerosolutions.com' title='user1318@axerosolutions.com'>user1318@axerosolutions.com</a>\",\"RenderedValues\":[\"<a href='mailto:user1318@axerosolutions.com' title='user1318@axerosolutions.com'>user1318@axerosolutions.com</a>\"],\"FieldUTCDate\":null,\"FieldUTCDates\":[],\"LookupValue\":null,\"LookupValues\":[],\"FieldValues\":[\"user1318@axerosolutions.com\"],\"FieldValue2\":\"\",\"FieldValues2\":[],\"OptionResourceKeys\":[],\"ChildFields\":{},\"LookupValueContentTypes\":null,\"Indexed\":false,\"IsPreference\":false.......}]",
      "FilterFields": [
        {
          "_fieldValues": [
            "user1318@axerosolutions.com"
          ],
          "<FieldUseID>k__BackingField": 9,
          "<FieldValueFiltered>k__BackingField": "lessthana href=apostrophemailtocolonuser1318ataxerosolutionsdotcomapostrophe title=apostropheuser1318ataxerosolutionsdotcomapostrophegreaterthanuser1318ataxerosolutionsdotcomlessthanforwardslashagreaterthan",
          "<FieldValueSpecialCharsStripped>k__BackingField": " a href= mailto user1318 axerosolutions com  title= user1318 axerosolutions com  user1318 axerosolutions com  a "
        },
        {
          "_fieldValues": [
            "Alice"
          ],
          "<FieldUseID>k__BackingField": 63,
          "<FieldValueFiltered>k__BackingField": "Alice",
          "<FieldValueSpecialCharsStripped>k__BackingField": "Alice"
        },
        {
          "_fieldValues": [
            "Romero"
          ],
          "<FieldUseID>k__BackingField": 64,
          "<FieldValueFiltered>k__BackingField": "Romero",
          "<FieldValueSpecialCharsStripped>k__BackingField": "Romero"
        }
      ],
      "IndexedFieldValuesFiltered": "Alice Romero Axero Solutions Sales Representative 2156 Emeral Dreams Drive Thomson 90120 httpscolonforwardslashforwardslashmyintranetdotcommunifiredotcomforwardslashAssetsforwardslashUploadedhyphenPhotosforwardslash602forwardslash309eb012hyphenc9e2hyphen4292hyphena78ehyphen1985c1e8593bdotjpg Sales fdasfdfad",
      "IndexedFieldValuesSpecialCharsStripped": "Alice Romero Axero Solutions Sales Representative 2156 Emeral Dreams Drive Thomson 90120 https   myintranet communifire com Assets Uploaded Photos 602 309eb012 c9e2 4292 a78e 1985c1e8593b jpg Sales fdasfdfad",
      "IsIsolated": false,
      "UserFirstName": "Alice",
      "UserLastName": "Romero",
      "UserEmail": "user1318@axerosolutions.com",
      "UserName": "alice",
      "UserNameFilterAppliedWithSpecialCharactersStripped": "alice",
      "UserSignature": "",
      "WallPostToUserID": 0,
      "PermissionCheckAuthorID": 602,
      "DateCreated": "2017-10-31T05:44:47.91",
      "DatePublished": "2017-10-31T05:44:47.91",
      "DateUpdated": "0001-01-01T00:00:00",
      "ShowDate": true,
      "ShowMetaData": true,
      "DateCreatedString": "10/30/2017",
      "DatePublishedString": "10/30/2017",
      "AuthorUserID": 602,
      "AuthorUsername": "alice",
      "AuthorUserDisplayName": "Alice Level3",
      "AuthorUserAvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/602/06d4a455-7bd7-4c40-9ece-18f12387650c.jpg",
      "AuthorUserProfileURL": "https://myintranet.communifire.com/people/alice",
      "SpaceID": 0,
      "ContentStatusID": 0,
      "ContentCurrentWorkFlowStepID": 0,
      "EntityType": 15,
      "EntityTypeText": "User",
      "ContentID": 602,
      "ContentURL": "/people/alice",
      "ContentImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/602/06d4a455-7bd7-4c40-9ece-18f12387650c.jpg",
      "ContentMediaServerID": 42,
      "WallID": 0,
      "ContentStub": "alice",
      "GreatGrandParentContentID": 0,
      "ForumPostForumID": 0,
      "ForumPostTopicID": 0,
      "EntityIconCssClass": "icon-user",
      "IsExternalContent": false,
      "ParentEntityType": 0,
      "ParentContentID": 0,
      "ContentDetailImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/602/8ec77e10-fc0f-4a3c-8f41-67d3c38eec8d.jpg",
      "ContentFeaturedImage": "06d4a455-7bd7-4c40-9ece-18f12387650c.jpg",
      "UserIsProfilePublic": true,
      "UserIsActivated": true,
      "CommentCount": 0,
      "LikeCount": 0,
      "PageViews": 0,
      "Rating": 0.0,
      "IsComment": false,
      "IsSpaceLevel": false,
      "IsFeatured": false,
      "IsLatest": false,
      "IsContentPubliclyAccessible": false,
      "IsAddedFromActivityStream": false,
      "ShowRating": true,
      "ShowViewCount": true,
      "ShowCommentCount": true,
      "EventStartDate": "0001-01-01T00:00:00",
      "IsRecurringTime": false,
      "EventEndDate": "0001-01-01T00:00:00",
      "EventScheduleStartDate": "0001-01-01T00:00:00",
      "EventScheduleEndDate": "0001-01-01T00:00:00",
      "EventCountryID": 0,
      "EventStateID": 0,
      "EventMetroID": 0,
      "EventIsAllDay": false,
      "EventIsPrivate": false,
      "EventTypeID": 0,
      "SpaceVisibility": 0,
      "TotalChildRecords": 0,
      "RankName": "Lurker",
      "RankImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/rank-lurker.gif",
      "ChatStatusText": "Offline",
      "ChatStatusCSSClass": "status-offline",
      "SpaceIDs": [
        "252",
        "257"
      ],
      "AwardID": 0,
      "MembershipContentID": 0,
      "ConnectedToUser": false,
      "IssueCommentIsProjectActive": false,
      "IssueCommentIsInternal": false,
      "IssueCommentIssueID": 0,
      "ActivityActionEnum": 0,
      "ActivityLogBrowserType": 0,
      "ActivityLogOperatingSys": 0,
      "ActivityLogUserID": 0,
      "IndexedContentType": 3
    }
  ]
}

 

Please Note Pass application/json as the content type in the header of your request.

Wiki Index

Pages

Intranet Software