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 Mailbox

  • REST Method: GET
  • URLs: https://api.helpscout.net/v1/mailboxes/{id}.json

Response

Response Name Type Notes
Header Status Int 200
Body item Mailbox   
Status: 200 OK
{
    item: {
        "id": 1234,
        "name": "My Mailbox",
        "slug": "47204a026903ce6d",
        "email": "help@mymailbox.com",
        "createdAt": "2012-07-23T12:34:12Z",
        "modifiedAt": "2012-07-24T20:18:33Z",
        "folders": [{
                "id": 1234,
                "name": "Mine",
                "type": "mine",
                "userId": 4532,
                "totalCount": 2,
                "activeCount": 1,
                "modifiedAt": "2012-07-24T20:18:33Z"
            },
            {... folder object ...}
        ]
    }
}
↑Back to top
© Help Scout 2024