Documentation

API /users/find/customField/{groupName}/{customFieldName}

ThoughtFarmer REST API Method: /users/find/customField/{templateId}

Gets every user that matches a value for a particular custom field in a custom field group.

URL:
http://yourserver.com/api/users/find/customField/{groupName}/{customFieldName}

http://yourserver.com/api/2.0/users/find/customField/{groupName}/{customFieldName}


Response Formats:
xml,json

HTTP Method(s):
GET

Requires Authentication:
true, user making call must pass a valid token parameter

Parameters:

Parameter Type Description
customfieldgroup string Required. The group name of the custom field to retreive the data for
customfieldname string Required. The name of the custom field. This is the sanitized name of the custom field. e.g. a filed called Start Date would be santized to StartDate.
value string Required. The specific value you are searching for
token string Required. A valid token authentication parameter
  Response Status Codes:
200 - Success
401 - Token parameter is invalid
500 - The template id is not valid or the value to update is missing
 
Example request
GET http://yourserver.com/api/users/find/customField/{groupName}/{customFieldName}&value={value}&token={token}
[
   {
      "AbbreviatedTitle":[
         {
            "Key":"en",
            "Value":""
         }
      ],
      "ContentId":1589,
      "CreatorId":46,
      "DateModified":"\/Date(1298068629500-0800)\/",
      "DatePosted":"\/Date(1226721195110-0800)\/",
      "DatePublished":"\/Date(1226721195423-0800)\/",
      "GrandParentId":1,
      "LastModifiedBy":"...",
      "ModifiedId":72,
      "OwnerId":11,
      "ParentId":3,
      "Summary":[
         {
            "Key":"en",
            "Value":""
         }
      ],
      "Title":[
         {
            "Key":"en",
            "Value":"..."
         }
      ],
      "TreePath":"...",
      "ViewTypes":[
         18,
         6
      ],
      "Body":[
         {
            "Key":"en",
            "Value":""
         }
      ],
      "Birthday":"\/Date(216658800000-0800)\/",
      "BirthdayDisplay":2,
      "DefaultCulture":"en",
      "DisplayName":"",
      "DomainLogin":"...",
      "Email":"radams@axio.com",
      "FirstName":"Rachel",
      "ImageUrlLarge":"\/imagethumb\/814295000000\/288\/0x0\/False\/rachel_adams.jpg",
      "ImageUrlMedium":"\/imagethumb\/814295000000\/288\/250x250\/False\/rachel_adams.jpg",
      "ImageUrlSmall":"\/imagethumb\/814295000000\/288\/50x50\/False\/rachel_adams.jpg",
      "JobTitle":"",
      "LastName":"Adams",
      "LeaderPrimaryId":3,
      "LeaderSecondaryId":0,
      "PhoneFax":"",
      "PhoneMobile":"01 2914000",
      "PhoneTel":"01 679332",
      "SalutationId":0,
      "Status":"Reviewing Thought Farmer's UI.",
      "StatusLastUpdated":"\/Date(1237223477117-0700)\/",
      "StatusLastUpdatedRelative":"Updated Mar 16, 2009",
      "TimeZone":"GMT Standard Time",
      "UserId":59
   },
   {
      "AbbreviatedTitle":[
         {
            "Key":"en",
            "Value":""
         }
      ],
      "ContentId":1583,
      "CreatorId":46,
      "DateModified":"\/Date(1275539651267-0700)\/",
      "DatePosted":"\/Date(1226717556263-0800)\/",
      "DatePublished":"\/Date(1226717556627-0800)\/",
      "GrandParentId":1,
      "LastModifiedBy":"...",
      "ModifiedId":72,
      "OwnerId":53,
      "ParentId":3,
      "Summary":[
         {
            "Key":"en",
            "Value":""
         }
      ],
      "Title":[
         {
            "Key":"en",
            "Value":"..."
         }
      ],
      "TreePath":"...",
      "ViewTypes":[
         18,
         6
      ],
      "Body":[
         {
            "Key":"en",
            "Value":""
         }
      ],
      "Birthday":"\/Date(-512820000000-0700)\/",
      "BirthdayDisplay":2,
      "DefaultCulture":"en",
      "DisplayName":"Grace",
      "DomainLogin":"...",
      "Email":"gandrews@axio.com",
      "FirstName":"Grace",
      "ImageUrlLarge":"\/imagethumb\/164512670000\/283\/0x0\/False\/grace_andrews.jpg",
      "ImageUrlMedium":"\/imagethumb\/164512670000\/283\/250x250\/False\/grace_andrews.jpg",
      "ImageUrlSmall":"\/imagethumb\/164512670000\/283\/50x50\/False\/grace_andrews.jpg",
      "JobTitle":"",
      "LastName":"Andrews",
      "LeaderPrimaryId":5,
      "LeaderSecondaryId":12,
      "PhoneFax":"",
      "PhoneMobile":"(416) 606-2311",
      "PhoneTel":"(416) 260-1652",
      "SalutationId":4004,
      "Status":"",
      "StatusLastUpdated":"\/Date(-62135568000000-0800)\/",
      "StatusLastUpdatedRelative":"Updated Jan 1, 0001",
      "TimeZone":"Pacific Standard Time",
      "UserId":53
   }
]