Get Customer

Request

GET /v2/customers/100 HTTP/1.1
Authorization: Bearer oauth_token

URL Parameters

Parameter | Description ——— | ———– embed | Allows embedding of customer sub-entities, allowed values are:
address
chats
emails
phones
social_profiles
websites. The embedded data can be found in _embedded object. ?embed=emails will add emails into _embedded.emails.

Response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8

{
  "id" : 500,
  "firstName" : "Vernon",
  "lastName" : "Bear",
  "gender" : "Male",
  "jobTitle" : "CEO and Co-Founder",
  "location" : "Greater Dallas/FT Worth Area",
  "organization" : "Acme, Inc",
  "photoType" : "twitter",
  "photoUrl" : "http://twitter.com/img/some-avatar.jpg",
  "age" : "30-35",
  "createdAt" : "2012-07-23T12:34:12Z",
  "updatedAt" : "2012-07-24T20:18:33Z",
  "background" : "I've worked with Vernon before and he's really great.",
  "_links" : {
    "address" : {
      "href" : "..."
    },
    "chats" : {
      "href" : "..."
    },
    "emails" : {
      "href" : "..."
    },
    "phones" : {
      "href" : "..."
    },
    "self" : {
      "href" : "..."
    },
    "social-profiles" : {
      "href" : "..."
    },
    "websites" : {
      "href" : "..."
    }
  }
}

Response fields

Path Type Description
firstName String First name of the customer. Must be shorter than 40 characters
lastName String Last name of the customer. Must be shorter than 40 characters
photoUrl String URL of the customer’s photo
jobTitle String Job title
photoType String Type of photo. Possible values include:
unknown
gravatar
twitter
facebook
googleprofile
googleplus
linkedin
background String This is the Notes field from the user interface.
location String Location of the customer
createdAt String Time and date when the customer was created (UTC)
updatedAt String Time and date when the customer was update (UTC)
organization String Organization
gender String Gender of this customer. Possible values include:
male
female
unknown
age String Customer’s age
id Number Unique identifier
_embedded Object Container for embedded customer sub entities which can be loaded via embed query parameter
Relation Description
address Customer’s address
chats Customer’s chat handles
emails Customer’s emails
phones Customer’s phones
social-profiles Customer’s social profiles
websites Customer’s websites