Get Customer

Request

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

Path Parameters

/v2/customers/{customerId}

Response

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
  "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.",
  "draft" : false,
  "_embedded" : {
    "emails" : [ {
      "id" : 1,
      "value" : "bear@acme.com",
      "type" : "home"
    } ],
    "phones" : [ {
      "id" : 2,
      "value" : "123-123-123",
      "type" : "home"
    } ],
    "chats" : [ {
      "id" : 5,
      "value" : "54831172",
      "type" : "aim"
    } ],
    "social_profiles" : [ {
      "id" : 4,
      "value" : "@me",
      "type" : "twitter"
    } ],
    "websites" : [ {
      "id" : 3,
      "value" : "http://home.com"
    } ],
    "properties" : [ {
      "type" : "text",
      "slug" : "car",
      "name" : "Car",
      "value" : "Tesla",
      "text" : "Tesla",
      "source" : {
        "name" : "api"
      }
    } ],
    "address" : {
      "city" : "Prague",
      "lines" : [ ]
    }
  },
  "_links" : {
    "address" : {
      "href" : "..."
    },
    "chats" : {
      "href" : "..."
    },
    "emails" : {
      "href" : "..."
    },
    "phones" : {
      "href" : "..."
    },
    "social-profiles" : {
      "href" : "..."
    },
    "websites" : {
      "href" : "..."
    },
    "self" : {
      "href" : "..."
    }
  }
}

Response fields

Path Type Description
firstName String First name of the customer. When defined it must be between 1 and 40 characters.
lastName String Last name of the customer. When defined it must be between 1 and 40 characters.
phone String Optional phone number that will be used when creating a new customer
photoUrl String URL of the customer’s photo. Max length 200 characters.
jobTitle String Job title. Max length 60 characters.
photoType String Type of photo. Accepted values are:
unknown
gravatar
twitter
facebook
googleprofile
googleplus
linkedin
instagram
background String This is the Notes field from the user interface. Max length 200 characters.
location String Location of the customer. Max length 60 characters.
organization String Organization. Max length 60 characters.
gender String Gender of this customer. Accepted values are:
male
female
unknown
age String Customer’s age
id Number Unique identifier
createdAt String Time and date when the customer was created (UTC)
updatedAt String Time and date when the customer was update (UTC)
draft Boolean If true the customer is considered a draft record until the associated conversation draft is created.
_embedded Object Container for embedded customer sub entities

Response fields

Path Type Description
slug String Property slug - unique identifier of the property
name String Property name
type String Property type - describes the value type, one of:
date
dropdown
number
text
url
value String Property value - only present if the value was set. The value depends on property type. It contains an option ID for the dropdown property type, for example.
text String Property text - only present if the value was set. It is equal to value for all the properties with the exception of dropdown - it contains option label in case of dropdowns
source Object Property source - identifies sub-system that updated the property
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
↑Back to top
© Help Scout 2024