List Sites

  • REST Method: GET
  • URL: https://docsapi.helpscout.net/v1/sites

Request

Name Type Required Default Options Notes
page Int No 1    

To request subsequent pages:
https://docsapi.helpscout.net/v1/sites?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 Site objects.
{   
    "page": 1,
    "pages": 1,
    "count": 4,
    "items": [
        {
            "id": 23478,
            "status": "active",
            "subDomain": "helpscout",
            "cname": "docs.helpscout.net",
            "hasPublicSite": true,
            "companyName": "Help Scout",
            "title": "Help Scout Support",
            "logoUrl": "http://helpscout.net/logo.png",
            "logoWidth": 174,
            "logoHeight": 40,
            "favIconUrl": "http://helpscout.net/favicon.png",
            "touchIconUrl": "http://helpscout.net/touchicon.png",
            "homeUrl": "http://helpscout.net",
            "homeLinkText": "Home",
            "bgColor": "#444444",
            "description": "Frequently asked questions and support for Help Scout",
            "hasContactForm": true,
            "mailboxId": 968,
            "contactEmail": null,
            "styleSheetUrl": "http://helpscout.net/docs-style.css",
            "headerCode": null,
            "createdBy": 29456,
            "updatedBy": 29456,
            "createdAt": "2013-12-10T15:09:52Z",
            "updatedAt": "2013-12-10T15:09:52Z"
        },
        {... site object ...},
        {... site object ...},
        {... site object ...}
    ]
}