Site

Get site info

GET

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

Can be used to fetch all categories and subcategories

Get site info

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

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

const data = await response.text();

import requests

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

200

{
  "default_archetype": "string",
  "notification_types": {
    "mentioned": 0,
    "replied": 0,
    "quoted": 0,
    "edited": 0,
    "liked": 0,
    "private_message": 0,
    "invited_to_private_message": 0,
    "invitee_accepted": 0,
    "posted": 0,
    "watching_category_or_tag": 0,
    "new_features": 0,
    "admin_problems": 0,
    "moved_post": 0,
    "linked": 0,
    "granted_badge": 0,
    "invited_to_topic": 0,
    "custom": 0,
    "group_mentioned": 0,
    "group_message_summary": 0,
    "watching_first_post": 0,
    "topic_reminder": 0,
    "liked_consolidated": 0,
    "linked_consolidated": 0,
    "post_approved": 0,
    "code_review_commit_approved": 0,
    "membership_request_accepted": 0,
    "membership_request_consolidated": 0,
    "bookmark_reminder": 0,
    "reaction": 0,
    "votes_released": 0,
    "event_reminder": 0,
    "event_invitation": 0,
    "chat_mention": 0,
    "chat_message": 0,
    "chat_invitation": 0,
    "chat_group_mention": 0,
    "chat_quoted": 0,
    "chat_watched_thread": 0,
    "upcoming_change_available": 0,
    "upcoming_change_automatically_promoted": 0,
    "assigned": 0,
    "question_answer_user_commented": 0,
    "following": 0,
    "following_created_topic": 0,
    "following_replied": 0,
    "circles_activity": 0,
    "boost": 0,
    "suggested_edit_created": 0,
    "suggested_edit_accepted": 0,
    "live_invitation": 0
  },
  "post_types": {
    "regular": 0,
    "moderator_action": 0,
    "small_action": 0,
    "whisper": 0
  },
  "trust_levels": {
    "newuser": 0,
    "basic": 0,
    "member": 0,
    "regular": 0,
    "leader": 0
  },
  "user_tips": {
    "first_notification": 0,
    "topic_timeline": 0,
    "post_menu": 0,
    "topic_notification_levels": 0,
    "suggested_topics": 0
  },
  "groups": [
    {
      "id": 0,
      "name": "string",
      "full_name": "string",
      "display_name": "string",
      "flair_url": "string",
      "flair_bg_color": "string",
      "flair_color": "string",
      "automatic": true
    }
  ],
  "filters": [],
  "anonymous_list_filters": [],
  "homepage_choices": [],
  "homepage_options": [
    {
      "id": "string",
      "path": "string",
      "server_side": true
    }
  ],
  "periods": [],
  "top_menu_items": [],
  "anonymous_top_menu_items": [],
  "uncategorized_category_id": 0,
  "user_field_max_length": 0,
  "post_action_types": [
    {
      "id": 0,
      "name_key": "string",
      "name": "string",
      "description": "string",
      "short_description": "string",
      "is_flag": true,
      "require_message": true,
      "enabled": true,
      "applies_to": [],
      "is_used": true,
      "position": 0,
      "auto_action_type": true,
      "system": true
    }
  ],
  "topic_flag_types": [
    {
      "id": 0,
      "name_key": "string",
      "name": "string",
      "description": "string",
      "short_description": "string",
      "is_flag": true,
      "require_message": true,
      "enabled": true,
      "applies_to": [],
      "is_used": true,
      "position": 0,
      "auto_action_type": true,
      "system": true
    }
  ],
  "can_create_tag": true,
  "can_search": true,
  "can_tag_topics": true,
  "can_tag_pms": true,
  "tags_filter_regexp": "string",
  "top_tags": [
    {
      "id": 0,
      "name": "string",
      "slug": "string"
    }
  ],
  "wizard_required": true,
  "can_associate_groups": true,
  "email_configured": true,
  "upcoming_changes_with_css": [
    "string"
  ],
  "topic_featured_link_allowed_category_ids": [],
  "user_themes": [
    {
      "theme_id": 0,
      "name": "string",
      "default": true,
      "color_scheme_id": 0,
      "dark_color_scheme_id": 0,
      "only_theme_color_schemes": true
    }
  ],
  "user_color_schemes": [
    {
      "id": 0,
      "name": "string",
      "is_dark": true,
      "theme_id": 0,
      "colors": []
    }
  ],
  "default_light_color_scheme": {},
  "default_dark_color_scheme": {},
  "censored_regexp": [
    {}
  ],
  "custom_emoji_translation": {},
  "watched_words_replace": "string",
  "watched_words_link": "string",
  "markdown_additional_options": {},
  "hashtag_configurations": {},
  "hashtag_icons": {},
  "displayed_about_plugin_stat_groups": [],
  "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,
      "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,
      "allow_global_tags": true,
      "required_tag_groups": [
        {
          "min_count": 0
        }
      ],
      "read_only_banner": "string",
      "uploaded_logo": "string",
      "uploaded_logo_dark": "string",
      "uploaded_background": "string",
      "uploaded_background_dark": "string",
      "can_edit": true,
      "custom_fields": {},
      "parent_category_id": 0,
      "form_template_ids": [],
      "category_types": {}
    }
  ],
  "archetypes": [
    {
      "id": "string",
      "name": "string",
      "options": []
    }
  ],
  "user_fields": [],
  "auth_providers": [],
  "whispers_allowed_groups_names": [],
  "denied_emojis": [],
  "valid_flag_applies_to_types": [],
  "navigation_menu_site_top_tags": [],
  "full_name_required_for_signup": true,
  "full_name_visible_in_signup": true,
  "admin_config_login_routes": [],
  "access_control": {
    "mandatory_acl": {},
    "banned_acl": {}
  },
  "permanent_upcoming_change_names": [
    "string"
  ],
  "category_types": [
    {
      "id": "string",
      "name": "string",
      "title": "string",
      "description": "string",
      "icon": "string",
      "available": true,
      "visible": true,
      "configuration_schema": {}
    }
  ]
}

Response

200OKany

success response

Response fields application/json

default_archetypestringrequired

notification_typesobjectrequired

Show child attributes

mentionedintegerrequired

repliedintegerrequired

quotedintegerrequired

editedintegerrequired

likedintegerrequired

private_messageintegerrequired

invited_to_private_messageintegerrequired

invitee_acceptedintegerrequired

postedintegerrequired

watching_category_or_tagintegerrequired

new_featuresinteger

admin_problemsinteger

moved_postintegerrequired

linkedintegerrequired

granted_badgeintegerrequired

invited_to_topicintegerrequired

customintegerrequired

group_mentionedintegerrequired

group_message_summaryintegerrequired

watching_first_postintegerrequired

topic_reminderintegerrequired

liked_consolidatedintegerrequired

linked_consolidatedintegerrequired

post_approvedintegerrequired

code_review_commit_approvedintegerrequired

membership_request_acceptedintegerrequired

membership_request_consolidatedintegerrequired

bookmark_reminderintegerrequired

reactionintegerrequired

votes_releasedintegerrequired

event_reminderintegerrequired

event_invitationintegerrequired

chat_mentionintegerrequired

chat_messageintegerrequired

chat_invitationintegerrequired

chat_group_mentionintegerrequired

chat_quotedinteger

chat_watched_threadinteger

upcoming_change_availableinteger

upcoming_change_automatically_promotedinteger

assignedinteger

question_answer_user_commentedinteger

followinginteger

following_created_topicinteger

following_repliedinteger

circles_activityinteger

boostinteger

suggested_edit_createdinteger

suggested_edit_acceptedinteger

live_invitationinteger

post_typesobjectrequired

Show child attributes

regularintegerrequired

moderator_actionintegerrequired

small_actionintegerrequired

whisperintegerrequired

trust_levelsobjectrequired

Show child attributes

newuserintegerrequired

basicintegerrequired

memberintegerrequired

regularintegerrequired

leaderintegerrequired

user_tipsobject

Show child attributes

first_notificationintegerrequired

topic_timelineintegerrequired

post_menuintegerrequired

topic_notification_levelsintegerrequired

suggested_topicsintegerrequired

groupsArray<object>required

Show child attributes

idintegerrequired

namestringrequired

full_namestring

display_namestring

flair_urlstring | nullrequired

flair_bg_colorstring | nullrequired

flair_colorstring | nullrequired

automaticbooleanrequired

filtersArray<any>required

anonymous_list_filtersArray<any>required

homepage_choicesArray<any>required

homepage_optionsArray<object>required

Show child attributes

idstringrequired

pathstringrequired

server_sidebooleanrequired

periodsArray<any>required

top_menu_itemsArray<any>required

anonymous_top_menu_itemsArray<any>required

uncategorized_category_idintegerrequired

user_field_max_lengthintegerrequired

post_action_typesArray<object>required

Show child attributes

idinteger | nullrequired

name_keystring | nullrequired

namestringrequired

descriptionstringrequired

short_descriptionstringrequired

is_flagbooleanrequired

require_messagebooleanrequired

enabledbooleanrequired

applies_toarrayrequired

is_usedbooleanrequired

positioninteger

auto_action_typebooleanrequired

systemboolean

topic_flag_typesArray<object>required

Show child attributes

idinteger | nullrequired

name_keystring | nullrequired

namestringrequired

descriptionstringrequired

short_descriptionstringrequired

is_flagbooleanrequired

require_messagebooleanrequired

enabledbooleanrequired

applies_toarrayrequired

is_usedbooleanrequired

positioninteger

auto_action_typebooleanrequired

systemboolean

can_create_tagbooleanrequired

can_searchbooleanrequired

can_tag_topicsbooleanrequired

can_tag_pmsbooleanrequired

tags_filter_regexpstringrequired

top_tagsArray<object>required

Show child attributes

idintegerrequired

namestringrequired

slugstringrequired

wizard_requiredboolean

can_associate_groupsboolean

email_configuredbooleanrequired

upcoming_changes_with_cssArray<string>

topic_featured_link_allowed_category_idsArray<any>required

user_themesArray<object>required

Show child attributes

theme_idintegerrequired

namestringrequired

defaultbooleanrequired

color_scheme_idinteger | nullrequired

dark_color_scheme_idinteger | null

only_theme_color_schemesboolean

user_color_schemesArray<object>required

Show child attributes

idintegerrequired

namestringrequired

is_darkbooleanrequired

theme_idinteger | null

colorsarrayrequired

default_light_color_schemeobject | nullrequired

default_dark_color_schemeobject | nullrequired

censored_regexpArray<object>required

custom_emoji_translationobjectrequired

watched_words_replacestring | nullrequired

watched_words_linkstring | nullrequired

markdown_additional_optionsobject

hashtag_configurationsobject

hashtag_iconsobject

displayed_about_plugin_stat_groupsarray

categoriesArray<object>required

Show child attributes

idintegerrequired

namestringrequired

colorstringrequired

text_colorstringrequired

style_typestring

emojistring | null

iconstring | null

slugstringrequired

topic_countintegerrequired

post_countintegerrequired

positionintegerrequired

descriptionstring | null

description_textstring | null

description_excerptstring | null

topic_urlstringrequired

read_restrictedbooleanrequired

permissionintegerrequired

notification_levelintegerrequired

topic_templatestring | nullrequired

topic_title_placeholderstring | nullrequired

has_childrenbooleanrequired

subcategory_countinteger | nullrequired

sort_orderstring | nullrequired

sort_ascendingstring | nullrequired

show_subcategory_listbooleanrequired

num_featured_topicsintegerrequired

default_viewstring | nullrequired

subcategory_list_stylestringrequired

default_top_periodstringrequired

default_list_filterstringrequired

minimum_required_tagsintegerrequired

navigate_to_first_post_after_readbooleanrequired

allow_global_tagsbooleanrequired

required_tag_groupsArray<object>required

Show child attributes

min_countintegerrequired

read_only_bannerstring | nullrequired

uploaded_logostring | nullrequired

uploaded_logo_darkstring | nullrequired

uploaded_backgroundstring | nullrequired

uploaded_background_darkstring | nullrequired

can_editbooleanrequired

custom_fieldsobject | null

parent_category_idinteger

form_template_idsArray<any>

category_typesobject

archetypesArray<object>required

Show child attributes

idstringrequired

namestringrequired

optionsArray<any>required

user_fieldsArray<any>required

auth_providersArray<any>required

whispers_allowed_groups_namesarray

denied_emojisarray

valid_flag_applies_to_typesarray

navigation_menu_site_top_tagsarray

full_name_required_for_signupbooleanrequired

full_name_visible_in_signupbooleanrequired

admin_config_login_routesarray

access_controlobject

Show child attributes

mandatory_aclobjectrequired

banned_aclobjectrequired

permanent_upcoming_change_namesArray<string>

category_typesArray<object>

Show child attributes

idstringrequired

namestringrequired

titlestringrequired

descriptionstringrequired

iconstringrequired

availablebooleanrequired

visiblebooleanrequired

configuration_schemaobjectrequired

Docs by Sourcey