Get site info

GET 
/site.json

Can be used to fetch all categories and subcategories

Responses

200

success response

application/json

Schema

Schema

default_archetype stringrequired
notification_types objectrequired
mentioned integerrequired
replied integerrequired
quoted integerrequired
edited integerrequired
liked integerrequired
private_message integerrequired
invited_to_private_message integerrequired
invitee_accepted integerrequired
posted integerrequired
watching_category_or_tag integerrequired
new_features integerrequired
admin_problems integerrequired
moved_post integerrequired
linked integerrequired
granted_badge integerrequired
invited_to_topic integerrequired
custom integerrequired
group_mentioned integerrequired
group_message_summary integerrequired
watching_first_post integerrequired
topic_reminder integerrequired
liked_consolidated integerrequired
linked_consolidated integerrequired
post_approved integerrequired
code_review_commit_approved integerrequired
membership_request_accepted integerrequired
membership_request_consolidated integerrequired
bookmark_reminder integerrequired
reaction integerrequired
votes_released integerrequired
event_reminder integerrequired
event_invitation integerrequired
chat_mention integerrequired
chat_message integerrequired
chat_invitation integerrequired
chat_group_mention integerrequired
chat_quoted integerrequired
assigned integerrequired
question_answer_user_commented integerrequired
following integerrequired
following_created_topic integerrequired
following_replied integerrequired
circles_activity integerrequired
post_types objectrequired
regular integerrequired
moderator_action integerrequired
small_action integerrequired
whisper integerrequired
trust_levels objectrequired
newuser integerrequired
basic integerrequired
member integerrequired
regular integerrequired
leader integerrequired
user_tips object
first_notification integerrequired
topic_timeline integerrequired
post_menu integerrequired
topic_notification_levels integerrequired
suggested_topics integerrequired
groups object[]required
Array [
id integerrequired
name stringrequired
flair_url stringnullrequired
flair_bg_color stringnullrequired
flair_color stringnullrequired
]
filters undefined[]required
periods undefined[]required
top_menu_items undefined[]required
anonymous_top_menu_items undefined[]required
uncategorized_category_id integerrequired
user_field_max_length integerrequired
post_action_types object[]required
Array [
id integernullrequired
name_key stringnullrequired
name stringrequired
description stringrequired
short_description stringrequired
is_flag booleanrequired
is_custom_flag booleanrequired
enabled booleanrequired
]
topic_flag_types object[]required
Array [
id integernullrequired
name_key stringnullrequired
name stringrequired
description stringrequired
short_description stringrequired
is_flag booleanrequired
is_custom_flag booleanrequired
enabled booleanrequired
]
can_create_tag booleanrequired
can_tag_topics booleanrequired
can_tag_pms booleanrequired
tags_filter_regexp stringrequired
top_tags undefined[]required
wizard_required booleanrequired
can_associate_groups booleanrequired
topic_featured_link_allowed_category_ids undefined[]required
user_themes object[]required
Array [
theme_id integerrequired
name stringrequired
default booleanrequired
color_scheme_id integernullrequired
]
user_color_schemes object[]required
Array [
id integerrequired
name stringrequired
is_dark booleanrequired
]
default_dark_color_scheme objectnullrequired
censored_regexp object[]required
custom_emoji_translation objectrequired
watched_words_replace stringnullrequired
watched_words_link stringnullrequired
markdown_additional_options objectrequired
hashtag_configurations objectrequired
hashtag_icons objectrequired
displayed_about_plugin_stat_groups arrayrequired
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 stringrequired
read_restricted booleanrequired
permission integerrequired
notification_level integerrequired
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
allowed_tags undefined[]required
allowed_tag_groups undefined[]required
allow_global_tags booleanrequired
required_tag_groups object[]required
Array [
name stringrequired
min_count integerrequired
]
read_only_banner stringnullrequired
uploaded_logo stringnullrequired
uploaded_logo_dark stringnullrequired
uploaded_background stringnullrequired
uploaded_background_dark stringnullrequired
can_edit booleanrequired
custom_fields object,null
parent_category_id integerrequired
form_template_ids undefined[]required
]
archetypes object[]required
Array [
id stringrequired
name stringrequired
options undefined[]required
]
user_fields undefined[]required
auth_providers undefined[]required
whispers_allowed_groups_names arrayrequired
denied_emojis arrayrequired
navigation_menu_site_top_tags arrayrequired

Example (from schema)

{
  "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,
    "assigned": 0,
    "question_answer_user_commented": 0,
    "following": 0,
    "following_created_topic": 0,
    "following_replied": 0,
    "circles_activity": 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"
    }
  ],
  "filters": [
    null
  ],
  "periods": [
    null
  ],
  "top_menu_items": [
    null
  ],
  "anonymous_top_menu_items": [
    null
  ],
  "uncategorized_category_id": 0,
  "user_field_max_length": 0,
  "post_action_types": [
    {
      "name": "string",
      "description": "string",
      "short_description": "string",
      "is_flag": true,
      "is_custom_flag": true,
      "enabled": true
    }
  ],
  "topic_flag_types": [
    {
      "name": "string",
      "description": "string",
      "short_description": "string",
      "is_flag": true,
      "is_custom_flag": true,
      "enabled": true
    }
  ],
  "can_create_tag": true,
  "can_tag_topics": true,
  "can_tag_pms": true,
  "tags_filter_regexp": "string",
  "top_tags": [
    null
  ],
  "wizard_required": true,
  "can_associate_groups": true,
  "topic_featured_link_allowed_category_ids": [
    null
  ],
  "user_themes": [
    {
      "theme_id": 0,
      "name": "string",
      "default": true
    }
  ],
  "user_color_schemes": [
    {
      "id": 0,
      "name": "string",
      "is_dark": true
    }
  ],
  "censored_regexp": [
    {}
  ],
  "custom_emoji_translation": {},
  "markdown_additional_options": {},
  "hashtag_configurations": {},
  "hashtag_icons": {},
  "displayed_about_plugin_stat_groups": [
    null
  ],
  "categories": [
    {
      "id": 0,
      "name": "string",
      "color": "string",
      "text_color": "string",
      "slug": "string",
      "topic_count": 0,
      "post_count": 0,
      "position": 0,
      "topic_url": "string",
      "read_restricted": true,
      "permission": 0,
      "notification_level": 0,
      "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,
      "allowed_tags": [
        null
      ],
      "allowed_tag_groups": [
        null
      ],
      "allow_global_tags": true,
      "required_tag_groups": [
        {
          "name": "string",
          "min_count": 0
        }
      ],
      "can_edit": true,
      "parent_category_id": 0,
      "form_template_ids": [
        null
      ]
    }
  ],
  "archetypes": [
    {
      "id": "string",
      "name": "string",
      "options": [
        null
      ]
    }
  ],
  "user_fields": [
    null
  ],
  "auth_providers": [
    null
  ],
  "whispers_allowed_groups_names": [
    null
  ],
  "denied_emojis": [
    null
  ],
  "navigation_menu_site_top_tags": [
    null
  ]
}

Loading...