--- title: "Get information about the specified forum" method: GET path: "/forums/{id}/" tags: ["Forums"] --- # Get information about the specified forum `GET /forums/{id}/` Get information about the specified forum. ## Query parameters - `with_threads` boolean - `page` integer - `prefix_id` integer - `starter_id` integer - `last_days` integer - `unread` boolean - `thread_type` string - `order` string - `direction` string ## Response `200` OK - object - `forum` Forum - `forum_type_id` string - `allow_posting` boolean - `require_prefix` boolean - `min_tags` integer - `threads` Thread[] — Threads on this page - `username` string - `is_watching` boolean — If accessing as a user, true if they are watching this thread - `visitor_post_count` integer — If accessing as a user, the number of posts they have made in this thread - `is_unread` boolean — If accessing as a user, true if this thread is unread - `custom_fields` object — Key-value pairs of custom field values for this thread - `tags` unknown[] - unknown - `prefix` string — Present if this thread has a prefix. Printable name of the prefix. - `can_edit` boolean - `can_edit_tags` boolean - `can_reply` boolean - `can_soft_delete` boolean - `can_hard_delete` boolean - `can_view_attachments` boolean - `view_url` string - `is_first_post_pinned` boolean - `highlighted_post_ids` unknown[] - unknown - `is_search_engine_indexable` boolean - `index_state` string — Present for members with permission to change the search index state of this thread. - `Forum` Node - `breadcrumbs` unknown[] — A list of breadcrumbs for this node, including the node_id, title, and node_type_id - unknown - `type_data` object — Data related to the specific node type this represents. Contents will vary significantly. - `view_url` string - `node_id` integer - `title` string - `node_name` string - `description` string - `node_type_id` string - `parent_node_id` integer - `display_order` integer - `display_in_list` boolean - `vote_score` integer — The content's vote score (if supported) - `can_content_vote` boolean — True if the viewing user can vote on this content - `allowed_content_vote_types` string[] — List of content vote types allowed on this content - `is_content_voted` boolean — True if the viewing user has voted on this content - `visitor_content_vote` string — If the viewer reacted, the vote they case (up/down) - `thread_id` integer - `node_id` integer - `title` string - `reply_count` integer - `view_count` integer - `user_id` integer - `post_date` integer - `sticky` boolean - `discussion_state` string - `discussion_open` boolean - `discussion_type` string - `first_post_id` integer - `last_post_date` integer - `last_post_id` integer - `last_post_user_id` integer - `last_post_username` string - `first_post_reaction_score` integer - `prefix_id` integer - `featured` boolean - `User` User — Information about the user. Different information will be included based on permissions and verbosity. - `about` string - `activity_visible` boolean - `age` integer — The user's current age. Only included if available. - `alert_optout` unknown[] - unknown - `allow_post_profile` string - `allow_receive_news_feed` string - `allow_send_personal_conversation` string - `allow_view_identities` string - `allow_view_profile` string - `avatar_urls` object — Maps from size types to URL. - `profile_banner_urls` object — Maps from size types to URL. - `can_ban` boolean - `can_converse` boolean - `can_edit` boolean - `can_follow` boolean - `can_ignore` boolean - `can_post_profile` boolean - `can_view_profile` boolean - `can_view_profile_posts` boolean - `can_warn` boolean - `content_show_signature` boolean - `creation_watch_state` string - `custom_fields` object — Map of custom field keys and values. - `custom_title` string — Will have a value if a custom title has been specifically set; prefer user_title instead. - `dob` object — Date of birth with year, month and day keys. - `email` string - `email_on_conversation` boolean - `gravatar` string - `interaction_watch_state` boolean - `is_admin` boolean - `is_banned` boolean - `is_discouraged` boolean - `is_followed` boolean — True if the visitor is following this user. Only included if visitor is not a guest. - `is_ignored` boolean — True if the visitor is ignoring this user. Only included if visitor is not a guest. - `is_moderator` boolean - `is_super_admin` boolean - `last_activity` integer — Unix timestamp of user's last activity, if available. - `location` string - `push_on_conversation` boolean - `push_optout` unknown[] - unknown - `receive_admin_email` boolean - `secondary_group_ids` unknown[] - unknown - `show_dob_date` boolean - `show_dob_year` boolean - `signature` string - `timezone` string - `use_tfa` boolean - `user_group_id` integer - `user_state` string - `user_title` string - `visible` boolean - `warning_points` integer — Current warning points. - `website` string - `view_url` string - `user_id` integer - `username` string - `message_count` integer - `question_solution_count` integer - `register_date` integer - `trophy_points` integer - `is_staff` boolean - `reaction_score` integer - `vote_score` integer - `pagination` Pagination — Pagination details for paginated responses. - `current_page` integer — The current page number. - `last_page` integer — The last page number. - `per_page` integer — The number of items per page. - `shown` integer — The number of items returned. - `total` integer — The total number of items. - `sticky` Thread[] — If on page 1, a list of sticky threads in this forum. Does not count towards the per page limit. - `username` string - `is_watching` boolean — If accessing as a user, true if they are watching this thread - `visitor_post_count` integer — If accessing as a user, the number of posts they have made in this thread - `is_unread` boolean — If accessing as a user, true if this thread is unread - `custom_fields` object — Key-value pairs of custom field values for this thread - `tags` unknown[] - unknown - `prefix` string — Present if this thread has a prefix. Printable name of the prefix. - `can_edit` boolean - `can_edit_tags` boolean - `can_reply` boolean - `can_soft_delete` boolean - `can_hard_delete` boolean - `can_view_attachments` boolean - `view_url` string - `is_first_post_pinned` boolean - `highlighted_post_ids` unknown[] - unknown - `is_search_engine_indexable` boolean - `index_state` string — Present for members with permission to change the search index state of this thread. - `Forum` Node - `breadcrumbs` unknown[] — A list of breadcrumbs for this node, including the node_id, title, and node_type_id - unknown - `type_data` object — Data related to the specific node type this represents. Contents will vary significantly. - `view_url` string - `node_id` integer - `title` string - `node_name` string - `description` string - `node_type_id` string - `parent_node_id` integer - `display_order` integer - `display_in_list` boolean - `vote_score` integer — The content's vote score (if supported) - `can_content_vote` boolean — True if the viewing user can vote on this content - `allowed_content_vote_types` string[] — List of content vote types allowed on this content - `is_content_voted` boolean — True if the viewing user has voted on this content - `visitor_content_vote` string — If the viewer reacted, the vote they case (up/down) - `thread_id` integer - `node_id` integer - `title` string - `reply_count` integer - `view_count` integer - `user_id` integer - `post_date` integer - `sticky` boolean - `discussion_state` string - `discussion_open` boolean - `discussion_type` string - `first_post_id` integer - `last_post_date` integer - `last_post_id` integer - `last_post_user_id` integer - `last_post_username` string - `first_post_reaction_score` integer - `prefix_id` integer - `featured` boolean - `User` User — Information about the user. Different information will be included based on permissions and verbosity. - `about` string - `activity_visible` boolean - `age` integer — The user's current age. Only included if available. - `alert_optout` unknown[] - unknown - `allow_post_profile` string - `allow_receive_news_feed` string - `allow_send_personal_conversation` string - `allow_view_identities` string - `allow_view_profile` string - `avatar_urls` object — Maps from size types to URL. - `profile_banner_urls` object — Maps from size types to URL. - `can_ban` boolean - `can_converse` boolean - `can_edit` boolean - `can_follow` boolean - `can_ignore` boolean - `can_post_profile` boolean - `can_view_profile` boolean - `can_view_profile_posts` boolean - `can_warn` boolean - `content_show_signature` boolean - `creation_watch_state` string - `custom_fields` object — Map of custom field keys and values. - `custom_title` string — Will have a value if a custom title has been specifically set; prefer user_title instead. - `dob` object — Date of birth with year, month and day keys. - `email` string - `email_on_conversation` boolean - `gravatar` string - `interaction_watch_state` boolean - `is_admin` boolean - `is_banned` boolean - `is_discouraged` boolean - `is_followed` boolean — True if the visitor is following this user. Only included if visitor is not a guest. - `is_ignored` boolean — True if the visitor is ignoring this user. Only included if visitor is not a guest. - `is_moderator` boolean - `is_super_admin` boolean - `last_activity` integer — Unix timestamp of user's last activity, if available. - `location` string - `push_on_conversation` boolean - `push_optout` unknown[] - unknown - `receive_admin_email` boolean - `secondary_group_ids` unknown[] - unknown - `show_dob_date` boolean - `show_dob_year` boolean - `signature` string - `timezone` string - `use_tfa` boolean - `user_group_id` integer - `user_state` string - `user_title` string - `visible` boolean - `warning_points` integer — Current warning points. - `website` string - `view_url` string - `user_id` integer - `username` string - `message_count` integer - `question_solution_count` integer - `register_date` integer - `trophy_points` integer - `is_staff` boolean - `reaction_score` integer - `vote_score` integer ## Other responses - `default` — Error --- [API](https://skmtc.net/xenforo-ltd/apis/xenforo-api.md) · [All operations](https://skmtc.net/xenforo-ltd/apis/xenforo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xenforo-ltd/xenforo-api/revisions/b15eba33657a/schema)