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.

List Customers

  • REST Method: GET
  • URL: https://api.helpscout.net/v1/customers.json

Customers can be filtered on any combination of first name, last name, email, and modifiedSince.

Example:
https://api.helpscout.net/v1/customers.json?firstName=John&lastName=Appleseed&email=john@example.com&modifiedSince=2013-11-20T13:31:49Z&page=2

At this time all customers are returned by createdAt date (from newest to oldest).

Request

Name Type Required Default Notes
firstName String No    
lastName String No    
email String No    
modifiedSince DateTime No   Returns customers that have been modified since the given date/time. Date/time is in UTC.
page Int No 1  

Response

Response Name Type Notes
Header Status Int 200
Body page Int Current page that was passed in on the request
  pages Int Total number of pages available
  count Int Total number of objects available
items Collection Collection of Customer objects. 
Status: 200 OK
{
    "page": 1,
    "pages": 1,
    "count": 4,
    "items": [{
        "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",
        "createdAt": "2012-07-23T12:34:12Z",
        "modifiedAt": "2012-07-24T20:18:33Z"
    },
    {... customer object ...},
    {... customer object ...},
    {... customer object ...}
    ]
}
↑Back to top
© Help Scout 2024