Category Object

Field Overview

Name Type Example Notes
project_id String 559f118932131c6576ccb5be *Required unique identifier
status String active *Required. Can be one of the following: 'active',  'deleted'.
url_hash URL safe string category-name *Required. Permalinks (url_hash) must be lowercase and not include any illegal URL characters.
visibility String public *Required. Can be either 'public' or 'custom'. Custom is used for categories restricted to reader groups.
name Array ['en' => 'Category Name'] *Required. Names are stored by 2 letter language code.
type String basic *Required. Can be one of the following: 'basic', 'content', 'faq'.
toc_title Array ['en' => 'Short Name'] Shorter version of the title which will be displayed in the table of contents.
faq_display String content Can be one of the following: 'content', 'description'.
toc_hide_children Boolean false Hide all child content from table of contents.
index Int 1 The order in which the category will be displayed within its container.
description String This is the description for a category
hide_from_toc Boolean false Do not display this article in the table of contents.
parent_id String 559f118932131c6576ccb5be Unique ID referencing parent category object.
cat_toggle_override String collapse Can be set to one of the following: 'collapse', 'open'.
reader_roles Array ['53fea499fe775a996c00000c', '53fea499fe775a996c00000d'] Array of unique IDs referencing reader_roles objects. Article viewing will be restricted to those reader groups.
user_teams Array ['53fea499fe775a996c00000c', '56ae706091121c6c70f24275'] Unique IDs referencing user_team objects.

Example Response


stdClass Object
(
    [valid] => 1
    [data] => stdClass Object
        (
            [id] => 56ae702491121c3e6ef2425d
            [type] => basic
            [project_id] => 559f118932131c6576ccb5be
            [name] => Array (
                    [en] => Objects
            	)
            [toc_title] => Array (
                    [en] => 
                )
            [faq_display] => description
            [toc_hide_children] => 
            [description] => 
            [languages] => 
            [visibility] => public
            [parent_id] => 559f1194ed121c95258b45c9
            [url_hash] => objects
            [application_screens] => Array (
                    [0] => 
                )
            [date_created] => 
            [date_modified] => 01/31/2016 3:36 pm EST
            [date_published] => 
            [status] => active
            [index] => 2
            [cat_toggle_override] => open
            [reader_roles] => 
            [hide_from_toc] => 
            [category_link] => 
            [redirect_link] => 
            [user_teams] => 
        )
)