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 Users

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

Request

Name Type Required Default Notes
page Int No 1  
type string No   Allowed values: user or team

To request subsequent pages:
https://api.helpscout.net/v1/users.json?page=2

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 User objects 
Status: 200 OK
{   
    "page": 1,
    "pages": 1,
    "count": 4,
    "items": [{
        "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",
        "type" : "team"
      },
      {... user object ...},
      {... user object ...},
      {... user object ...}
    ]
}
↑Back to top
© Help Scout 2024