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.
Get Customer
- REST Method: GET
- URL: https://api.helpscout.net/v1/customers/{id}.json
Response
| Response | Name | Type | Notes |
|---|---|---|---|
| Header | Status | Int | 200 |
| Body | item | Customer |
Status: 200 OK
{
item: {
"id": 29418,
"firstName": "Vernon",
"lastName": "Bear",
"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",
"background": "I've worked with Vernon before and he's really great.",
"createdAt": "2012-07-23T12:34:12Z",
"modifiedAt": "2012-07-24T20:18:33Z",
"address": {
"id": 1234,
"lines": [
"123 West Main St",
"Suite 123"
],
"city": "Dallas",
"state": "TX",
"postcalCode": "74206",
"country": "US",
"createdAt": "2012-07-23T12:34:12Z"
"modifiedAt": "2012-07-24T20:18:33Z"
},
"socialProfiles": [
{
"id": 9184,
"url": "https://twitter.com/helpscout",
"type": "twitter"
},
{... social profile object ...}
],
"emails": [{
"id": 98131,
"url": "vbear@mywork.com",
"type": "work"
},
{... email object ...}
],
"phones": [{
"id": 22381,
"value": "222-333-4444",
"location": "home"
},
{... phone object ...}
],
"chats": [{
"id": 77183,
"value": "jsprout",
"type": "aim"
},
{... chat object ...}
],
"websites": [{
"id": 5584,
"value": "http://www.somewhere.com"
},
{... website object ...}
],
}
}