Retrieves a list of categories

GET 
/categories.json

Retrieves a list of categories

Request

Query Parameters

include_subcategories boolean

Possible values: [true]

Responses

200

success response

application/json

Schema

Schema

category_list objectrequired
can_create_category booleanrequired
can_create_topic booleanrequired
categories object[]required
Array [
id integerrequired
name stringrequired
color stringrequired
text_color stringrequired
slug stringrequired
topic_count integerrequired
post_count integerrequired
position integerrequired
description stringnullrequired
description_text stringnullrequired
description_excerpt stringnullrequired
topic_url stringnullrequired
read_restricted booleanrequired
permission integerrequired
notification_level integerrequired
can_edit booleanrequired
topic_template stringnullrequired
has_children booleanrequired
subcategory_count integernullrequired
sort_order stringnullrequired
sort_ascending stringnullrequired
show_subcategory_list booleanrequired
num_featured_topics integerrequired
default_view stringnullrequired
subcategory_list_style stringrequired
default_top_period stringrequired
default_list_filter stringrequired
minimum_required_tags integerrequired
navigate_to_first_post_after_read booleanrequired
topics_day integerrequired
topics_week integerrequired
topics_month integerrequired
topics_year integerrequired
topics_all_time integerrequired
is_uncategorized booleanrequired
subcategory_ids undefined[]required
subcategory_list undefined[]required
uploaded_logo stringnullrequired
uploaded_logo_dark stringnullrequired
uploaded_background stringnullrequired
uploaded_background_dark stringnullrequired
]

Example (from schema)

{
  "category_list": {
    "can_create_category": true,
    "can_create_topic": true,
    "categories": [
      {
        "id": 0,
        "name": "string",
        "color": "string",
        "text_color": "string",
        "slug": "string",
        "topic_count": 0,
        "post_count": 0,
        "position": 0,
        "read_restricted": true,
        "permission": 0,
        "notification_level": 0,
        "can_edit": true,
        "has_children": true,
        "show_subcategory_list": true,
        "num_featured_topics": 0,
        "subcategory_list_style": "string",
        "default_top_period": "string",
        "default_list_filter": "string",
        "minimum_required_tags": 0,
        "navigate_to_first_post_after_read": true,
        "topics_day": 0,
        "topics_week": 0,
        "topics_month": 0,
        "topics_year": 0,
        "topics_all_time": 0,
        "is_uncategorized": true,
        "subcategory_ids": [
          null
        ]
      }
    ]
  }
}

Loading...