List Categories

  • REST Method: GET
  • URL: https://docsapi.helpscout.net/v1/collections/{id}/categories

Request

Name Type Required Default Options Notes
page Int No 1    
sort String No order
  • number
  • order
  • name
  • articleCount
  • createdAt
  • updatedAt
  
order String No asc
  • asc: ascending order
  • desc: descending order
  

To request subsequent pages:
https://docsapi.helpscout.net/v1/collections/{id}/categories?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 Category objects. 
{
    "categories": {
        "page": 1,
        "pages": 1,
        "count": 1,
        "items": [
            {
                "id": "5214c83d45667acd25394b54",
                "number": 113,
                "slug": "my-category",
                "collectionId": "5214c83d45667acd25394b53",
                "order": 1,
                "defaultSort": "name",
                "name": "My Category",
                "articleCount": 0,
                "createdBy": 73423,
                "updatedBy": null,
                "createdAt": "2013-08-21T14:01:33Z",
                "updatedAt": null
            },
            {... category object ...},
            {... category object ...},
            {... category object ...}
        ]
    }
}
↑Back to top
© Help Scout 2024