Legacy Mailbox API 1.0 is deprecated

Legacy Mailbox API 1.0 was deprecated on November 20, 2019. Please use Mailbox API 2.0 going forward. If you have any questions or need help with the new API, please reach out.

SearchCustomer Object

Field Guide

The following fields are returned when listing Customer search results.

Name Type Example Notes
id Int 2391938111 Unique identifier
firstName String John  
lastName String Appleseed  
fullName String John Appleseed  
emails Collection   A collection of Strings
photoUrl String http://twitter.com/img/some-avatar.jpg  
photoType String twitter Type of photo. Possible values include:
  • unknown
  • gravatar
  • twitter
  • facebook
  • googleprofile
  • googleplus
  • linkedin
gender String male Gender of this customer. Possible values include:
  • male
  • female
  • unknown
age String 30-35  
organization String Acme, Inc  
jobTitle String CEO and Co-Founder  
location String Greater Dallas/FT Worth Area  
createdAt Datetime 2012-07-23T12:34:12Z UTC time when this customer was created.
modifiedAt Datetime 2012-07-24T20:18:33Z UTC time when this customer was modified.

Example

{   
    "id": 2391938111,
    "firstName": "John",
    "lastName": "Appleseed",
    "fullName": "John Appleseed",
    "emails": {
    	"john@appleseed.com",
    	"johnappleseed@gmail.com"
    }
    "photoUrl": "http://twitter.com/img/some-avatar.jpg",
    "photoType": "twitter",
    "gender": "Male",
    "age": "30-35",
    "organization": "Acme, Inc",
    "jobTitle": "CEO and Co-Founder",
    "location": "Greater Dallas/FT Worth Area",
    "createdAt": "2012-07-23T12:34:12Z",
    "modifiedAt": "2012-07-24T20:18:33Z"
}
↑Back to top
© Help Scout 2024