Retrieves a list of categories

GET

https://discourse.example.com/categories.json

curl -X GET 'https://discourse.example.com/categories.json'

const response = await fetch('https://discourse.example.com/categories.json', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://discourse.example.com/categories.json')
print(response.text)

200

{
  "category_list": {
    "can_create_category": true,
    "can_create_topic": true,
    "categories": [
      {
        "id": 0,
        "name": "string",
        "color": "string",
        "text_color": "string",
        "style_type": "string",
        "emoji": "string",
        "icon": "string",
        "slug": "string",
        "topic_count": 0,
        "post_count": 0,
        "position": 0,
        "description": "string",
        "description_text": "string",
        "description_excerpt": "string",
        "topic_url": "string",
        "read_restricted": true,
        "permission": 0,
        "notification_level": 0,
        "can_edit": true,
        "topic_template": "string",
        "topic_title_placeholder": "string",
        "has_children": true,
        "subcategory_count": 0,
        "sort_order": "string",
        "sort_ascending": "string",
        "show_subcategory_list": true,
        "num_featured_topics": 0,
        "default_view": "string",
        "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": [],
        "subcategory_list": [],
        "uploaded_logo": "string",
        "uploaded_logo_dark": "string",
        "uploaded_background": "string",
        "uploaded_background_dark": "string"
      }
    ]
  }
}

Parameters

include_subcategoriesbooleantruequery

Response

200OKany

success response

Response fields application/json

Docs by Sourcey