Get Category

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

Note: Either the Category id or number can be passed to this endpoint.

Response

Response Name Type Notes
Header Status Int 200
Body category Category 
{
    "category": {
        "id": "5214c83d45667acd25394b54",
        "number": 133,
        "slug": "my-category",
        "collectionId": "5214c83d45667acd25394b53",
        "order": 1,
        "defaultSort": "name",
        "name": "My Category",
        "articleCount": 21,
        "createdBy": 73423,
        "updatedBy": null,
        "createdAt": "2013-08-21T14:01:33Z",
        "updatedAt": null
    }
}
↑Back to top
© Help Scout 2024