We're upgrading our API

On June 6th, 2019, Mailbox API 1.0 will be sunsetted, and at that time any apps using this legacy API will no longer work. Please use Mailbox API 2.0 instead.

Get User

  • REST Method: GET
  • URL: https://api.helpscout.net/v1/users/{id}.json
  • URL: https://api.helpscout.net/v1/users/me.json

The /v1/users/me.json endpoint will return the User associated with the API key used to make the request.

Response

Response Name Type Notes
Header Status Int 200
Body item User  
Status: 200 OK
{   
    item: {
        "id": 1234,
        "firstName": "Jack",
        "lastName": "Sprout",
        "email": "jack.sprout@gmail.com",
        "role": "owner",
        "timezone": "America/New_York",
        "photoUrl": "http://somesite.com/images/avatar.jpg",
        "createdAt": "2011-04-01T03:18:33Z",
        "modifiedAt": "2012-07-24T20:18:33Z"
    }
}