Collection Object

Field Guide

Name Type Example Notes
id String 5214c83d45667acd25394b53 Unique identifier
siteId String 52404efc4566740003092640 The id of the Site the Collection belongs to.
number Int 23 Numerical identifier. Useful for creating SEO friendly URLs (combined with a slug of the Collection name).
slug String "my-article" SEO-friendly identifier for the article that can be used in a URL.
visibility String public The visibility of the Collection. Possible values:
  • public - viewable by the public
  • private - viewable only in admin
order Integer 1 The display order for the Collection.
name String My Collection  
description String "A collection of my Docs." Optional description of the collection, up to 45 characters.
publicUrl String "https://my-docs.helpscoutdocs.com/collection/1-test" Publicly-accessible URL of the collection.
articleCount Integer 3 The number of articles in the collection (published and unpublished).
publishedArticleCount Integer 1 The number of published articles in the collection.
createdBy Integer 73423 The Help Scout id of the user who created the Collection.
updatedBy Integer 73423 The Help Scout id of the user who last updated the Collection.
createdAt DateTime "2013-08-21T19:34:13Z" The UTC date/time that the Collection was created.
updatedAt DateTime "2013-08-21T19:34:13Z" The UTC date/time that the Collection was last updated.

Example

{
    "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