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.

User Object

Field Guide

Name Type Example Notes
id Int 1234 Unique identifier
firstName String Jack  
lastName String Sprout  
email String jack.sprout@gmail.com  
role String owner Role of this user. Possible values include:
  • owner
  • admin
  • user
timezone String America/New_York  
photoUrl String http://www.somesite.com/images/avatar.jpg The user's photo, if one exists
createdAt Datetime 2011-04-01T03:18:33Z UTC time when this user was created.
modifiedAt Datetime 2012-07-24T20:18:33Z UTC time when this user was modified.
type String user User type - team or user

Example

{   
    "id": 1234,
    "firstName": "Jack",
    "lastName": "Sprout",
    "email": "jack.sprout@gmail.com",
    "role": "owner",
    "timezone": "America/New_York",
    "photoUrl": "http://www.somesite.com/images/avatar.jpg",
    "createdAt": "2011-04-01T03:18:33Z",
    "modifiedAt": "2012-07-24T20:18:33Z",
    "type" : "user"
}
↑Back to top
© Help Scout 2024