Get Collection

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

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

Response

Response Name Type Notes
Header Status Int 200
Body item Collection 
{
    "collection": {
        "id": "5214c83d45667acd25394b53",
        "siteId": "52404efc4566740003092640",
        "number": 33,
        "slug": "my-collection",
        "visibility": "public",
        "order": 1,
        "name": "My Collection",
        "description": "Description of my collection",
        "publicUrl": "https://my-docs.helpscoutdocs.com/collection/1-test",
        "articleCount": 3,
        "publishedArticleCount": 1,
        "createdBy": 73423,
        "updatedBy": 73423,
        "createdAt": "2013-08-21T14:01:33Z",
        "updatedAt": "2013-08-21T14:01:33Z"
    }
}
↑Back to top
© Help Scout 2024