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 Tags

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

Returns a list of tags used across all mailboxes. Tags are returned in alphabetical order, A-Z.

Request

Name Type Required Default Notes
page Int No 1  

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

Response

Response Name Type Notes
Header Status Int 200 if successful
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 Tag objects. 
Status: 200 OK
{
    "page": 1,
    "pages": 1,
    "count": 4,
    "items": [{
        "id": 1234,
        "slug": "my-tag",
        "tag": "My Tag",
        "count": 4,
        "color": "red",
        "createdAt": "2012-07-23T12:34:12Z",
        "modifiedAt": "2012-07-24T20:18:33Z"
    },
    {... tag object ...},
    {... tag object ...},
    {... tag object ...}
    ]
}
↑Back to top
© Help Scout 2024