Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://{defaultHost}
/admin/badges/{id}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer |
DELETE /admin/badges/{id}.json
/admin/groups/{id}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer |
DELETE /admin/groups/{id}.json
/groups/{id}/members.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupsRemoveMembersRequest"
}
}
}
}
DELETE /groups/{id}/members.json
/posts/{id}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostsDeleteSinglePostRequest"
}
}
}
}
DELETE /posts/{id}.json
/t/{id}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| Api-Key | header | required | string | |
| Api-Username | header | required | string | |
| id | path | required | string |
DELETE /t/{id}.json
/admin/users/{id}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsersDeleteUserByIdJsonRequest"
}
}
}
}
DELETE /admin/users/{id}.json
BackupsCreateBackupRequestRequest
{
"required": [
"with_uploads"
],
"properties": {
"with_uploads": {
"type": "boolean"
}
},
"additionalProperties": false
}
BackupsCreateBackupRequestResponse
{
"required": [
"success"
],
"properties": {
"success": {
"type": "string",
"example": "OK"
}
},
"additionalProperties": false
}
BackupsListResponse
{
"type": "array",
"items": {
"type": "object",
"required": [
"filename",
"size",
"last_modified"
],
"properties": {
"size": {
"type": "integer"
},
"filename": {
"type": "string"
},
"last_modified": {
"type": "string"
}
}
},
"minItems": 1,
"uniqueItems": true
}
BadgesCreateBadgeRequest
{
"required": [
"name",
"badge_type_id"
],
"properties": {
"name": {
"type": "string",
"description": "The name for the new badge."
},
"badge_type_id": {
"type": "integer",
"description": "The ID for the badge type. 1 for Gold, 2 for Silver,\n3 for Bronze."
}
},
"additionalProperties": false
}
BadgesCreateBadgeResponse
{
"required": [
"badge_types",
"badge"
],
"properties": {
"badge": {
"type": "object",
"required": [
"id",
"name",
"description",
"grant_count",
"allow_title",
"multiple_grant",
"icon",
"image_url",
"listable",
"enabled",
"badge_grouping_id",
"system",
"long_description",
"slug",
"manually_grantable",
"query",
"trigger",
"target_posts",
"auto_revoke",
"show_posts",
"badge_type_id"
],
"properties": {
"id": {
"type": "integer"
},
"icon": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"query": {
"type": [
"string",
"null"
]
},
"system": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"trigger": {
"type": [
"string",
"null"
]
},
"listable": {
"type": "boolean"
},
"image_url": {
"type": [
"string",
"null"
]
},
"show_posts": {
"type": "boolean"
},
"allow_title": {
"type": "boolean"
},
"auto_revoke": {
"type": "boolean"
},
"description": {
"type": "string"
},
"grant_count": {
"type": "integer"
},
"target_posts": {
"type": "boolean"
},
"badge_type_id": {
"type": "integer"
},
"multiple_grant": {
"type": "boolean"
},
"long_description": {
"type": "string"
},
"badge_grouping_id": {
"type": "integer"
},
"manually_grantable": {
"type": "boolean"
}
}
},
"badge_types": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"sort_order"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"sort_order": {
"type": "integer"
}
}
}
}
},
"additionalProperties": false
}
BadgesListResponse
{
"required": [
"badges",
"badge_types",
"badge_groupings",
"admin_badges"
],
"properties": {
"badges": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"description",
"grant_count",
"allow_title",
"multiple_grant",
"icon",
"image_url",
"listable",
"enabled",
"badge_grouping_id",
"system",
"long_description",
"slug",
"manually_grantable",
"query",
"trigger",
"target_posts",
"auto_revoke",
"show_posts",
"badge_type_id"
],
"properties": {
"id": {
"type": "integer"
},
"icon": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"query": {
"type": [
"string",
"null"
]
},
"system": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"trigger": {
"type": [
"integer",
"null"
]
},
"listable": {
"type": "boolean"
},
"i18n_name": {
"type": [
"string",
"null"
]
},
"image_url": {
"type": [
"string",
"null"
]
},
"show_posts": {
"type": "boolean"
},
"allow_title": {
"type": "boolean"
},
"auto_revoke": {
"type": "boolean"
},
"description": {
"type": "string"
},
"grant_count": {
"type": "integer"
},
"target_posts": {
"type": "boolean"
},
"badge_type_id": {
"type": "integer"
},
"multiple_grant": {
"type": "boolean"
},
"long_description": {
"type": "string"
},
"badge_grouping_id": {
"type": "integer"
},
"manually_grantable": {
"type": "boolean"
}
}
}
},
"badge_types": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"sort_order"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"sort_order": {
"type": "integer"
}
}
}
},
"admin_badges": {
"type": "object",
"required": [
"protected_system_fields",
"triggers",
"badge_ids",
"badge_grouping_ids",
"badge_type_ids"
],
"properties": {
"triggers": {
"type": "object",
"required": [
"user_change",
"none",
"post_revision",
"trust_level_change",
"post_action"
],
"properties": {
"none": {
"type": "integer"
},
"post_action": {
"type": "integer"
},
"user_change": {
"type": "integer"
},
"post_revision": {
"type": "integer"
},
"trust_level_change": {
"type": "integer"
}
}
},
"badge_ids": {
"type": "array",
"items": {}
},
"badge_type_ids": {
"type": "array",
"items": {}
},
"badge_grouping_ids": {
"type": "array",
"items": {}
},
"protected_system_fields": {
"type": "array",
"items": {}
}
}
},
"badge_groupings": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"description",
"position",
"system"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"system": {
"type": "boolean"
},
"position": {
"type": "integer"
},
"description": {
"type": [
"string",
"null"
]
}
}
}
}
},
"additionalProperties": false
}
BadgesListUserBadgesResponse
{
"required": [
"user_badges"
],
"properties": {
"badges": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"description",
"grant_count",
"allow_title",
"multiple_grant",
"icon",
"image_url",
"listable",
"enabled",
"badge_grouping_id",
"system",
"slug",
"manually_grantable",
"badge_type_id"
],
"properties": {
"id": {
"type": "integer"
},
"icon": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"system": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"listable": {
"type": "boolean"
},
"image_url": {
"type": [
"string",
"null"
]
},
"allow_title": {
"type": "boolean"
},
"description": {
"type": "string"
},
"grant_count": {
"type": "integer"
},
"badge_type_id": {
"type": "integer"
},
"multiple_grant": {
"type": "boolean"
},
"badge_grouping_id": {
"type": "integer"
},
"manually_grantable": {
"type": "boolean"
}
}
}
},
"badge_types": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"sort_order"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"sort_order": {
"type": "integer"
}
}
}
},
"user_badges": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"granted_at",
"grouping_position",
"is_favorite",
"can_favorite",
"badge_id",
"granted_by_id"
],
"properties": {
"id": {
"type": "integer"
},
"badge_id": {
"type": "integer"
},
"granted_at": {
"type": "string"
},
"is_favorite": {
"type": [
"string",
"null"
]
},
"can_favorite": {
"type": "boolean"
},
"granted_by_id": {
"type": "integer"
},
"grouping_position": {
"type": "integer"
}
}
}
},
"granted_bies": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"username",
"name",
"avatar_template",
"flair_name",
"admin",
"moderator",
"trust_level"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"admin": {
"type": "boolean"
},
"username": {
"type": "string"
},
"moderator": {
"type": "boolean"
},
"flair_name": {
"type": [
"string",
"null"
]
},
"trust_level": {
"type": "integer"
},
"avatar_template": {
"type": "string"
}
}
}
}
},
"additionalProperties": false
}
BadgesUpdateBadgeByIdJsonRequest
{
"required": [
"name",
"badge_type_id"
],
"properties": {
"name": {
"type": "string",
"description": "The name for the new badge."
},
"badge_type_id": {
"type": "integer",
"description": "The ID for the badge type. 1 for Gold, 2 for Silver,\n3 for Bronze."
}
},
"additionalProperties": false
}
BadgesUpdateBadgeByIdJsonResponse
{
"required": [
"badge_types",
"badge"
],
"properties": {
"badge": {
"type": "object",
"required": [
"id",
"name",
"description",
"grant_count",
"allow_title",
"multiple_grant",
"icon",
"image_url",
"listable",
"enabled",
"badge_grouping_id",
"system",
"long_description",
"slug",
"manually_grantable",
"query",
"trigger",
"target_posts",
"auto_revoke",
"show_posts",
"badge_type_id"
],
"properties": {
"id": {
"type": "integer"
},
"icon": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"query": {
"type": [
"string",
"null"
]
},
"system": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"trigger": {
"type": [
"string",
"null"
]
},
"listable": {
"type": "boolean"
},
"image_url": {
"type": [
"string",
"null"
]
},
"show_posts": {
"type": "boolean"
},
"allow_title": {
"type": "boolean"
},
"auto_revoke": {
"type": "boolean"
},
"description": {
"type": "string"
},
"grant_count": {
"type": "integer"
},
"target_posts": {
"type": "boolean"
},
"badge_type_id": {
"type": "integer"
},
"multiple_grant": {
"type": "boolean"
},
"long_description": {
"type": "string"
},
"badge_grouping_id": {
"type": "integer"
},
"manually_grantable": {
"type": "boolean"
}
}
},
"badge_types": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"sort_order"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"sort_order": {
"type": "integer"
}
}
}
}
},
"additionalProperties": false
}
CategoriesCreateCategoryRequestRequest
{
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"color": {
"type": "string",
"example": "49d9e9"
},
"text_color": {
"type": "string",
"example": "f0fcfd"
},
"permissions": {
"type": "object",
"properties": {
"staff": {
"type": "integer"
},
"everyone": {
"type": "integer",
"example": 1
}
},
"additionalProperties": true
},
"allow_badges": {
"type": "boolean"
},
"search_priority": {
"type": "integer"
},
"form_template_ids": {
"type": "array",
"items": {}
},
"parent_category_id": {
"type": "integer"
},
"topic_featured_links_allowed": {
"type": "boolean"
}
},
"additionalProperties": false
}
CategoriesCreateCategoryRequestResponse
{
"required": [
"category"
],
"properties": {
"category": {
"type": "object",
"required": [
"id",
"name",
"color",
"text_color",
"slug",
"topic_count",
"post_count",
"position",
"description",
"description_text",
"description_excerpt",
"topic_url",
"read_restricted",
"permission",
"notification_level",
"can_edit",
"topic_template",
"has_children",
"sort_order",
"sort_ascending",
"show_subcategory_list",
"num_featured_topics",
"default_view",
"subcategory_list_style",
"default_top_period",
"default_list_filter",
"minimum_required_tags",
"navigate_to_first_post_after_read",
"custom_fields",
"required_tag_groups",
"read_only_banner",
"available_groups",
"auto_close_hours",
"auto_close_based_on_last_post",
"allow_unlimited_owner_edits_on_first_post",
"default_slow_mode_seconds",
"group_permissions",
"email_in",
"email_in_allow_strangers",
"mailinglist_mirror",
"all_topics_wiki",
"can_delete",
"allow_badges",
"topic_featured_link_allowed",
"search_priority",
"uploaded_logo",
"uploaded_logo_dark",
"uploaded_background",
"uploaded_background_dark"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"color": {
"type": "string"
},
"can_edit": {
"type": "boolean"
},
"email_in": {
"type": [
"string",
"null"
]
},
"position": {
"type": "integer"
},
"topic_url": {
"type": [
"string",
"null"
]
},
"can_delete": {
"type": "boolean"
},
"permission": {
"type": [
"integer",
"null"
]
},
"post_count": {
"type": "integer"
},
"sort_order": {
"type": [
"string",
"null"
]
},
"text_color": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"topic_count": {
"type": "integer"
},
"allow_badges": {
"type": "boolean"
},
"allowed_tags": {
"type": "array",
"items": {}
},
"default_view": {
"type": [
"string",
"null"
]
},
"has_children": {
"type": [
"boolean",
"null"
]
},
"custom_fields": {
"type": "object",
"properties": {}
},
"uploaded_logo": {
"type": [
"string",
"null"
]
},
"sort_ascending": {
"type": [
"string",
"null"
]
},
"topic_template": {
"type": [
"string",
"null"
]
},
"all_topics_wiki": {
"type": "boolean"
},
"read_restricted": {
"type": "boolean"
},
"search_priority": {
"type": "integer"
},
"auto_close_hours": {
"type": [
"string",
"null"
]
},
"available_groups": {
"type": "array",
"items": {}
},
"category_setting": {
"num_auto_bump_daily": null,
"require_reply_approval": null,
"require_topic_approval": null,
"auto_bump_cooldown_days": 1
},
"description_text": {
"type": [
"string",
"null"
]
},
"read_only_banner": {
"type": [
"string",
"null"
]
},
"allow_global_tags": {
"type": "boolean"
},
"form_template_ids": {
"type": "array",
"items": {}
},
"group_permissions": {
"type": "array",
"items": {
"type": "object",
"required": [
"permission_type",
"group_name"
],
"properties": {
"group_name": {
"type": "string"
},
"permission_type": {
"type": "integer"
}
}
}
},
"allowed_tag_groups": {
"type": "array",
"items": {}
},
"default_top_period": {
"type": "string"
},
"mailinglist_mirror": {
"type": "boolean"
},
"notification_level": {
"type": "integer"
},
"uploaded_logo_dark": {
"type": [
"string",
"null"
]
},
"default_list_filter": {
"type": "string"
},
"description_excerpt": {
"type": [
"string",
"null"
]
},
"num_featured_topics": {
"type": "integer"
},
"required_tag_groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"min_count"
],
"properties": {
"name": {
"type": "string"
},
"min_count": {
"type": "integer"
}
}
}
},
"uploaded_background": {
"type": [
"string",
"null"
]
},
"minimum_required_tags": {
"type": "integer"
},
"show_subcategory_list": {
"type": "boolean"
},
"subcategory_list_style": {
"type": "string"
},
"email_in_allow_strangers": {
"type": "boolean"
},
"uploaded_background_dark": {
"type": [
"string",
"null"
]
},
"default_slow_mode_seconds": {
"type": [
"string",
"null"
]
},
"topic_featured_link_allowed": {
"type": "boolean"
},
"auto_close_based_on_last_post": {
"type": "boolean"
},
"navigate_to_first_post_after_read": {
"type": "boolean"
},
"allow_unlimited_owner_edits_on_first_post": {
"type": "boolean"
}
}
}
},
"additionalProperties": false
}
CategoriesGetCategoryByIdJsonResponse
{
"required": [
"category"
],
"properties": {
"category": {
"type": "object",
"required": [
"id",
"name",
"color",
"text_color",
"slug",
"topic_count",
"post_count",
"position",
"description",
"description_text",
"description_excerpt",
"topic_url",
"read_restricted",
"permission",
"notification_level",
"can_edit",
"topic_template",
"has_children",
"sort_order",
"sort_ascending",
"show_subcategory_list",
"num_featured_topics",
"default_view",
"subcategory_list_style",
"default_top_period",
"default_list_filter",
"minimum_required_tags",
"navigate_to_first_post_after_read",
"custom_fields",
"required_tag_groups",
"read_only_banner",
"available_groups",
"auto_close_hours",
"auto_close_based_on_last_post",
"allow_unlimited_owner_edits_on_first_post",
"default_slow_mode_seconds",
"group_permissions",
"email_in",
"email_in_allow_strangers",
"mailinglist_mirror",
"all_topics_wiki",
"can_delete",
"allow_badges",
"topic_featured_link_allowed",
"search_priority",
"uploaded_logo",
"uploaded_logo_dark",
"uploaded_background",
"uploaded_background_dark"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"color": {
"type": "string"
},
"can_edit": {
"type": "boolean"
},
"email_in": {
"type": [
"string",
"null"
]
},
"position": {
"type": "integer"
},
"topic_url": {
"type": [
"string",
"null"
]
},
"can_delete": {
"type": "boolean"
},
"permission": {
"type": [
"integer",
"null"
]
},
"post_count": {
"type": "integer"
},
"sort_order": {
"type": [
"string",
"null"
]
},
"text_color": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"topic_count": {
"type": "integer"
},
"allow_badges": {
"type": "boolean"
},
"allowed_tags": {
"type": "array",
"items": {}
},
"default_view": {
"type": [
"string",
"null"
]
},
"has_children": {
"type": [
"boolean",
"null"
]
},
"custom_fields": {
"type": "object",
"properties": {}
},
"uploaded_logo": {
"type": [
"string",
"null"
]
},
"sort_ascending": {
"type": [
"string",
"null"
]
},
"topic_template": {
"type": [
"string",
"null"
]
},
"all_topics_wiki": {
"type": "boolean"
},
"read_restricted": {
"type": "boolean"
},
"search_priority": {
"type": "integer"
},
"auto_close_hours": {
"type": [
"string",
"null"
]
},
"available_groups": {
"type": "array",
"items": {}
},
"category_setting": {
"num_auto_bump_daily": null,
"require_reply_approval": null,
"require_topic_approval": null,
"auto_bump_cooldown_days": 1
},
"description_text": {
"type": [
"string",
"null"
]
},
"read_only_banner": {
"type": [
"string",
"null"
]
},
"allow_global_tags": {
"type": "boolean"
},
"form_template_ids": {
"type": "array",
"items": {}
},
"group_permissions": {
"type": "array",
"items": {
"type": "object",
"required": [
"permission_type",
"group_name"
],
"properties": {
"group_name": {
"type": "string"
},
"permission_type": {
"type": "integer"
}
}
}
},
"allowed_tag_groups": {
"type": "array",
"items": {}
},
"default_top_period": {
"type": "string"
},
"mailinglist_mirror": {
"type": "boolean"
},
"notification_level": {
"type": "integer"
},
"uploaded_logo_dark": {
"type": [
"string",
"null"
]
},
"default_list_filter": {
"type": "string"
},
"description_excerpt": {
"type": [
"string",
"null"
]
},
"num_featured_topics": {
"type": "integer"
},
"required_tag_groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"min_count"
],
"properties": {
"name": {
"type": "string"
},
"min_count": {
"type": "integer"
}
}
}
},
"uploaded_background": {
"type": [
"string",
"null"
]
},
"minimum_required_tags": {
"type": "integer"
},
"show_subcategory_list": {
"type": "boolean"
},
"subcategory_list_style": {
"type": "string"
},
"email_in_allow_strangers": {
"type": "boolean"
},
"uploaded_background_dark": {
"type": [
"string",
"null"
]
},
"default_slow_mode_seconds": {
"type": [
"string",
"null"
]
},
"topic_featured_link_allowed": {
"type": "boolean"
},
"auto_close_based_on_last_post": {
"type": "boolean"
},
"navigate_to_first_post_after_read": {
"type": "boolean"
},
"allow_unlimited_owner_edits_on_first_post": {
"type": "boolean"
}
}
}
},
"additionalProperties": false
}
CategoriesListResponse
{
"required": [
"category_list"
],
"properties": {
"category_list": {
"type": "object",
"required": [
"can_create_category",
"can_create_topic",
"categories"
],
"properties": {
"categories": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"color",
"text_color",
"slug",
"topic_count",
"post_count",
"position",
"description",
"description_text",
"description_excerpt",
"topic_url",
"read_restricted",
"permission",
"notification_level",
"can_edit",
"topic_template",
"has_children",
"sort_order",
"sort_ascending",
"show_subcategory_list",
"num_featured_topics",
"default_view",
"subcategory_list_style",
"default_top_period",
"default_list_filter",
"minimum_required_tags",
"navigate_to_first_post_after_read",
"topics_day",
"topics_week",
"topics_month",
"topics_year",
"topics_all_time",
"subcategory_ids",
"uploaded_logo",
"uploaded_logo_dark",
"uploaded_background",
"uploaded_background_dark"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"color": {
"type": "string"
},
"can_edit": {
"type": "boolean"
},
"position": {
"type": "integer"
},
"topic_url": {
"type": [
"string",
"null"
]
},
"permission": {
"type": "integer"
},
"post_count": {
"type": "integer"
},
"sort_order": {
"type": [
"string",
"null"
]
},
"text_color": {
"type": "string"
},
"topics_day": {
"type": "integer"
},
"description": {
"type": [
"string",
"null"
]
},
"topic_count": {
"type": "integer"
},
"topics_week": {
"type": "integer"
},
"topics_year": {
"type": "integer"
},
"default_view": {
"type": [
"string",
"null"
]
},
"has_children": {
"type": "boolean"
},
"topics_month": {
"type": "integer"
},
"uploaded_logo": {
"type": [
"string",
"null"
]
},
"sort_ascending": {
"type": [
"string",
"null"
]
},
"topic_template": {
"type": [
"string",
"null"
]
},
"read_restricted": {
"type": "boolean"
},
"subcategory_ids": {
"type": "array",
"items": {}
},
"topics_all_time": {
"type": "integer"
},
"description_text": {
"type": [
"string",
"null"
]
},
"is_uncategorized": {
"type": "boolean"
},
"subcategory_list": {
"type": [
"array",
"null"
],
"items": {}
},
"default_top_period": {
"type": "string"
},
"notification_level": {
"type": "integer"
},
"uploaded_logo_dark": {
"type": [
"string",
"null"
]
},
"default_list_filter": {
"type": "string"
},
"description_excerpt": {
"type": [
"string",
"null"
]
},
"num_featured_topics": {
"type": "integer"
},
"uploaded_background": {
"type": [
"string",
"null"
]
},
"minimum_required_tags": {
"type": "integer"
},
"show_subcategory_list": {
"type": "boolean"
},
"subcategory_list_style": {
"type": "string"
},
"uploaded_background_dark": {
"type": [
"string",
"null"
]
},
"navigate_to_first_post_after_read": {
"type": "boolean"
}
}
}
},
"can_create_topic": {
"type": "boolean"
},
"can_create_category": {
"type": "boolean"
}
}
}
},
"additionalProperties": false
}
CategoriesListTopicsResponse
{
"required": [
"topic_list"
],
"properties": {
"users": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"username",
"name",
"avatar_template"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"username": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
}
}
},
"topic_list": {
"type": "object",
"required": [
"can_create_topic",
"per_page",
"topics"
],
"properties": {
"topics": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"title",
"fancy_title",
"slug",
"posts_count",
"reply_count",
"highest_post_number",
"image_url",
"created_at",
"last_posted_at",
"bumped",
"bumped_at",
"archetype",
"unseen",
"pinned",
"unpinned",
"excerpt",
"visible",
"closed",
"archived",
"bookmarked",
"liked",
"views",
"like_count",
"has_summary",
"last_poster_username",
"category_id",
"pinned_globally",
"featured_link",
"posters"
],
"properties": {
"id": {
"type": "integer"
},
"slug": {
"type": "string"
},
"liked": {
"type": [
"string",
"null"
]
},
"title": {
"type": "string"
},
"views": {
"type": "integer"
},
"bumped": {
"type": "boolean"
},
"closed": {
"type": "boolean"
},
"pinned": {
"type": "boolean"
},
"unseen": {
"type": "boolean"
},
"excerpt": {
"type": "string"
},
"posters": {
"type": "array",
"items": {
"type": "object",
"required": [
"extras",
"description",
"user_id",
"primary_group_id"
],
"properties": {
"extras": {
"type": "string"
},
"user_id": {
"type": "integer"
},
"description": {
"type": "string"
},
"primary_group_id": {
"type": [
"string",
"null"
]
}
}
}
},
"visible": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"unpinned": {
"type": [
"string",
"null"
]
},
"archetype": {
"type": "string"
},
"bumped_at": {
"type": "string"
},
"image_url": {
"type": [
"string",
"null"
]
},
"bookmarked": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string"
},
"like_count": {
"type": "integer"
},
"category_id": {
"type": "integer"
},
"fancy_title": {
"type": "string"
},
"has_summary": {
"type": "boolean"
},
"posts_count": {
"type": "integer"
},
"reply_count": {
"type": "integer"
},
"featured_link": {
"type": [
"string",
"null"
]
},
"last_posted_at": {
"type": "string"
},
"pinned_globally": {
"type": "boolean"
},
"highest_post_number": {
"type": "integer"
},
"last_poster_username": {
"type": "string"
}
}
}
},
"per_page": {
"type": "integer"
},
"top_tags": {
"type": "array",
"items": {}
},
"can_create_topic": {
"type": "boolean"
}
}
},
"primary_groups": {
"type": "array",
"items": {}
}
},
"additionalProperties": false
}
CategoriesUpdateCategoryByIdJsonRequest
{
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"color": {
"type": "string",
"example": "49d9e9"
},
"text_color": {
"type": "string",
"example": "f0fcfd"
},
"permissions": {
"type": "object",
"properties": {
"staff": {
"type": "integer"
},
"everyone": {
"type": "integer",
"example": 1
}
},
"additionalProperties": true
},
"allow_badges": {
"type": "boolean"
},
"search_priority": {
"type": "integer"
},
"form_template_ids": {
"type": "array",
"items": {}
},
"parent_category_id": {
"type": "integer"
},
"topic_featured_links_allowed": {
"type": "boolean"
}
},
"additionalProperties": false
}
CategoriesUpdateCategoryByIdJsonResponse
{
"required": [
"success",
"category"
],
"properties": {
"success": {
"type": "string"
},
"category": {
"type": "object",
"required": [
"id",
"name",
"color",
"text_color",
"slug",
"topic_count",
"post_count",
"position",
"description",
"description_text",
"description_excerpt",
"topic_url",
"read_restricted",
"permission",
"notification_level",
"can_edit",
"topic_template",
"form_template_ids",
"has_children",
"sort_order",
"sort_ascending",
"show_subcategory_list",
"num_featured_topics",
"default_view",
"subcategory_list_style",
"default_top_period",
"default_list_filter",
"minimum_required_tags",
"navigate_to_first_post_after_read",
"custom_fields",
"required_tag_groups",
"read_only_banner",
"available_groups",
"auto_close_hours",
"auto_close_based_on_last_post",
"allow_unlimited_owner_edits_on_first_post",
"default_slow_mode_seconds",
"group_permissions",
"email_in",
"email_in_allow_strangers",
"mailinglist_mirror",
"all_topics_wiki",
"can_delete",
"allow_badges",
"topic_featured_link_allowed",
"search_priority",
"uploaded_logo",
"uploaded_logo_dark",
"uploaded_background",
"uploaded_background_dark"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"color": {
"type": "string"
},
"can_edit": {
"type": "boolean"
},
"email_in": {
"type": [
"string",
"null"
]
},
"position": {
"type": "integer"
},
"topic_url": {
"type": [
"string",
"null"
]
},
"can_delete": {
"type": "boolean"
},
"permission": {
"type": [
"integer",
"null"
]
},
"post_count": {
"type": "integer"
},
"sort_order": {
"type": [
"string",
"null"
]
},
"text_color": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"topic_count": {
"type": "integer"
},
"allow_badges": {
"type": "boolean"
},
"allowed_tags": {
"type": "array",
"items": {}
},
"default_view": {
"type": [
"string",
"null"
]
},
"has_children": {
"type": [
"boolean",
"null"
]
},
"custom_fields": {
"type": "object",
"properties": {}
},
"uploaded_logo": {
"type": [
"string",
"null"
]
},
"sort_ascending": {
"type": [
"string",
"null"
]
},
"topic_template": {
"type": [
"string",
"null"
]
},
"all_topics_wiki": {
"type": "boolean"
},
"read_restricted": {
"type": "boolean"
},
"search_priority": {
"type": "integer"
},
"auto_close_hours": {
"type": [
"string",
"null"
]
},
"available_groups": {
"type": "array",
"items": {}
},
"category_setting": {
"num_auto_bump_daily": null,
"require_reply_approval": null,
"require_topic_approval": null,
"auto_bump_cooldown_days": 1
},
"description_text": {
"type": [
"string",
"null"
]
},
"read_only_banner": {
"type": [
"string",
"null"
]
},
"allow_global_tags": {
"type": "boolean"
},
"form_template_ids": {
"type": "array",
"items": {}
},
"group_permissions": {
"type": "array",
"items": {
"type": "object",
"required": [
"permission_type",
"group_name"
],
"properties": {
"group_name": {
"type": "string"
},
"permission_type": {
"type": "integer"
}
}
}
},
"allowed_tag_groups": {
"type": "array",
"items": {}
},
"default_top_period": {
"type": "string"
},
"mailinglist_mirror": {
"type": "boolean"
},
"notification_level": {
"type": "integer"
},
"uploaded_logo_dark": {
"type": [
"string",
"null"
]
},
"default_list_filter": {
"type": "string"
},
"description_excerpt": {
"type": [
"string",
"null"
]
},
"num_featured_topics": {
"type": "integer"
},
"required_tag_groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"min_count"
],
"properties": {
"name": {
"type": "string"
},
"min_count": {
"type": "integer"
}
}
}
},
"uploaded_background": {
"type": [
"string",
"null"
]
},
"minimum_required_tags": {
"type": "integer"
},
"show_subcategory_list": {
"type": "boolean"
},
"subcategory_list_style": {
"type": "string"
},
"email_in_allow_strangers": {
"type": "boolean"
},
"uploaded_background_dark": {
"type": [
"string",
"null"
]
},
"default_slow_mode_seconds": {
"type": [
"string",
"null"
]
},
"topic_featured_link_allowed": {
"type": "boolean"
},
"auto_close_based_on_last_post": {
"type": "boolean"
},
"navigate_to_first_post_after_read": {
"type": "boolean"
},
"allow_unlimited_owner_edits_on_first_post": {
"type": "boolean"
}
}
}
},
"additionalProperties": false
}
GroupsAddMembersToGroupRequest
{
"properties": {
"usernames": {
"type": "string",
"example": "username1,username2",
"description": "comma separated list"
}
},
"additionalProperties": false
}
GroupsAddMembersToGroupResponse
{
"required": [
"success",
"usernames",
"emails"
],
"properties": {
"emails": {
"type": "array",
"items": {}
},
"success": {
"type": "string"
},
"usernames": {
"type": "array",
"items": {}
}
},
"additionalProperties": false
}
GroupsCreateNewGroupRequest
{
"required": [
"group"
],
"properties": {
"group": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"bio_raw": {
"type": "string",
"description": "About Group"
},
"full_name": {
"type": "string"
},
"usernames": {
"type": "string",
"description": "comma,separated"
},
"flair_icon": {
"type": "string"
},
"public_exit": {
"type": "boolean"
},
"primary_group": {
"type": "boolean"
},
"flair_bg_color": {
"type": "string"
},
"flair_upload_id": {
"type": "integer"
},
"owner_usernames": {
"type": "string",
"description": "comma,separated"
},
"public_admission": {
"type": "boolean"
},
"visibility_level": {
"type": "integer"
},
"muted_category_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"regular_category_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"tracking_category_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"watching_category_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"default_notification_level": {
"type": "integer"
},
"watching_first_post_category_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"automatic_membership_email_domains": {
"type": "string",
"description": "pipe|separated"
}
}
}
},
"additionalProperties": false
}
GroupsCreateNewGroupResponse
{
"required": [
"basic_group"
],
"properties": {
"basic_group": {
"type": "object",
"required": [
"id",
"automatic",
"name",
"user_count",
"mentionable_level",
"messageable_level",
"visibility_level",
"primary_group",
"title",
"grant_trust_level",
"incoming_email",
"has_messages",
"flair_url",
"flair_bg_color",
"flair_color",
"bio_raw",
"bio_cooked",
"bio_excerpt",
"public_admission",
"public_exit",
"allow_membership_requests",
"full_name",
"default_notification_level",
"membership_request_template",
"members_visibility_level",
"can_see_members",
"can_admin_group",
"publish_read_state"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"title": {
"type": [
"string",
"null"
]
},
"bio_raw": {
"type": [
"string",
"null"
]
},
"automatic": {
"type": "boolean"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"full_name": {
"type": [
"string",
"null"
]
},
"bio_cooked": {
"type": [
"string",
"null"
]
},
"user_count": {
"type": "integer"
},
"bio_excerpt": {
"type": [
"string",
"null"
]
},
"flair_color": {
"type": [
"string",
"null"
]
},
"public_exit": {
"type": "boolean"
},
"has_messages": {
"type": "boolean"
},
"primary_group": {
"type": "boolean"
},
"can_edit_group": {
"type": "boolean"
},
"flair_bg_color": {
"type": [
"string",
"null"
]
},
"incoming_email": {
"type": [
"string",
"null"
]
},
"can_admin_group": {
"type": "boolean"
},
"can_see_members": {
"type": "boolean"
},
"public_admission": {
"type": "boolean"
},
"visibility_level": {
"type": "integer"
},
"grant_trust_level": {
"type": [
"string",
"null"
]
},
"mentionable_level": {
"type": "integer"
},
"messageable_level": {
"type": "integer"
},
"publish_read_state": {
"type": "boolean"
},
"members_visibility_level": {
"type": "integer"
},
"allow_membership_requests": {
"type": "boolean"
},
"default_notification_level": {
"type": "integer"
},
"membership_request_template": {
"type": [
"string",
"null"
]
}
}
}
},
"additionalProperties": false
}
GroupsDeleteGroupByIdJsonResponse
{
"required": [
"success"
],
"properties": {
"success": {
"type": "string",
"example": "OK"
}
},
"additionalProperties": false
}
GroupsGetGroupByIdResponse
{
"required": [
"group",
"extras"
],
"properties": {
"group": {
"type": "object",
"required": [
"id",
"automatic",
"name",
"user_count",
"mentionable_level",
"messageable_level",
"visibility_level",
"primary_group",
"title",
"grant_trust_level",
"incoming_email",
"has_messages",
"flair_url",
"flair_bg_color",
"flair_color",
"bio_raw",
"bio_cooked",
"bio_excerpt",
"public_admission",
"public_exit",
"allow_membership_requests",
"full_name",
"default_notification_level",
"membership_request_template",
"is_group_user",
"members_visibility_level",
"can_see_members",
"can_admin_group",
"publish_read_state",
"is_group_owner_display",
"mentionable",
"messageable",
"automatic_membership_email_domains",
"smtp_server",
"smtp_port",
"smtp_ssl",
"imap_server",
"imap_port",
"imap_ssl",
"imap_mailbox_name",
"imap_mailboxes",
"email_username",
"email_password",
"imap_last_error",
"imap_old_emails",
"imap_new_emails",
"message_count",
"allow_unknown_sender_topic_replies",
"watching_category_ids",
"tracking_category_ids",
"watching_first_post_category_ids",
"regular_category_ids",
"muted_category_ids"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"title": {
"type": [
"string",
"null"
]
},
"bio_raw": {
"type": [
"string",
"null"
]
},
"imap_ssl": {
"type": [
"string",
"null"
]
},
"smtp_ssl": {
"type": [
"string",
"null"
]
},
"automatic": {
"type": "boolean"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"full_name": {
"type": [
"string",
"null"
]
},
"imap_port": {
"type": [
"string",
"null"
]
},
"smtp_port": {
"type": [
"string",
"null"
]
},
"bio_cooked": {
"type": [
"string",
"null"
]
},
"muted_tags": {
"type": "array",
"items": {}
},
"user_count": {
"type": "integer"
},
"bio_excerpt": {
"type": [
"string",
"null"
]
},
"flair_color": {
"type": [
"string",
"null"
]
},
"imap_server": {
"type": [
"string",
"null"
]
},
"mentionable": {
"type": "boolean"
},
"messageable": {
"type": "boolean"
},
"public_exit": {
"type": "boolean"
},
"smtp_server": {
"type": [
"string",
"null"
]
},
"has_messages": {
"type": "boolean"
},
"imap_enabled": {
"type": "boolean"
},
"regular_tags": {
"type": "array",
"items": {}
},
"smtp_enabled": {
"type": "boolean"
},
"is_group_user": {
"type": "boolean"
},
"message_count": {
"type": "integer"
},
"primary_group": {
"type": "boolean"
},
"tracking_tags": {
"type": "array",
"items": {}
},
"watching_tags": {
"type": "array",
"items": {}
},
"can_edit_group": {
"type": "boolean"
},
"email_password": {
"type": [
"string",
"null"
]
},
"email_username": {
"type": [
"string",
"null"
]
},
"flair_bg_color": {
"type": [
"string",
"null"
]
},
"imap_mailboxes": {
"type": "array",
"items": {}
},
"incoming_email": {
"type": [
"string",
"null"
]
},
"can_admin_group": {
"type": "boolean"
},
"can_see_members": {
"type": "boolean"
},
"imap_last_error": {
"type": [
"string",
"null"
]
},
"imap_new_emails": {
"type": [
"string",
"null"
]
},
"imap_old_emails": {
"type": [
"string",
"null"
]
},
"imap_updated_at": {
"type": [
"string",
"null"
]
},
"imap_updated_by": {
"type": [
"object",
"null"
]
},
"smtp_updated_at": {
"type": [
"string",
"null"
]
},
"smtp_updated_by": {
"type": [
"object",
"null"
]
},
"email_from_alias": {
"type": [
"string",
"null"
]
},
"public_admission": {
"type": "boolean"
},
"visibility_level": {
"type": "integer"
},
"grant_trust_level": {
"type": [
"string",
"null"
]
},
"imap_mailbox_name": {
"type": "string"
},
"mentionable_level": {
"type": "integer"
},
"messageable_level": {
"type": "integer"
},
"muted_category_ids": {
"type": "array",
"items": {}
},
"publish_read_state": {
"type": "boolean"
},
"associated_group_ids": {
"type": "array",
"items": {}
},
"regular_category_ids": {
"type": "array",
"items": {}
},
"tracking_category_ids": {
"type": "array",
"items": {}
},
"watching_category_ids": {
"type": "array",
"items": {}
},
"is_group_owner_display": {
"type": "boolean"
},
"members_visibility_level": {
"type": "integer"
},
"watching_first_post_tags": {
"type": "array",
"items": {}
},
"allow_membership_requests": {
"type": "boolean"
},
"default_notification_level": {
"type": "integer"
},
"membership_request_template": {
"type": [
"string",
"null"
]
},
"watching_first_post_category_ids": {
"type": "array",
"items": {}
},
"allow_unknown_sender_topic_replies": {
"type": "boolean"
},
"automatic_membership_email_domains": {
"type": [
"string",
"null"
]
}
}
},
"extras": {
"type": "object",
"required": [
"visible_group_names"
],
"properties": {
"visible_group_names": {
"type": "array",
"items": {}
}
}
}
},
"additionalProperties": false
}
GroupsListMembersJsonResponse
{
"required": [
"members",
"owners",
"meta"
],
"properties": {
"meta": {
"type": "object",
"required": [
"total",
"limit",
"offset"
],
"properties": {
"limit": {
"type": "integer"
},
"total": {
"type": "integer"
},
"offset": {
"type": "integer"
}
}
},
"owners": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"username",
"name",
"avatar_template",
"title",
"last_posted_at",
"last_seen_at",
"added_at",
"timezone"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": [
"string",
"null"
]
},
"title": {
"type": [
"string",
"null"
]
},
"added_at": {
"type": "string"
},
"timezone": {
"type": "string"
},
"username": {
"type": "string"
},
"last_seen_at": {
"type": "string"
},
"last_posted_at": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
}
}
},
"members": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"username",
"name",
"avatar_template",
"title",
"last_posted_at",
"last_seen_at",
"added_at",
"timezone"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": [
"string",
"null"
]
},
"title": {
"type": [
"string",
"null"
]
},
"added_at": {
"type": "string"
},
"timezone": {
"type": "string"
},
"username": {
"type": "string"
},
"last_seen_at": {
"type": "string"
},
"last_posted_at": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
}
}
}
},
"additionalProperties": false
}
GroupsListResponse
{
"required": [
"groups",
"extras",
"total_rows_groups",
"load_more_groups"
],
"properties": {
"extras": {
"type": "object",
"required": [
"type_filters"
],
"properties": {
"type_filters": {
"type": "array",
"items": {}
}
}
},
"groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"automatic",
"name",
"display_name",
"user_count",
"mentionable_level",
"messageable_level",
"visibility_level",
"primary_group",
"title",
"grant_trust_level",
"incoming_email",
"has_messages",
"flair_url",
"flair_bg_color",
"flair_color",
"bio_raw",
"bio_cooked",
"bio_excerpt",
"public_admission",
"public_exit",
"allow_membership_requests",
"full_name",
"default_notification_level",
"membership_request_template",
"members_visibility_level",
"can_see_members",
"can_admin_group",
"publish_read_state"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"title": {
"type": [
"string",
"null"
]
},
"bio_raw": {
"type": [
"string",
"null"
]
},
"automatic": {
"type": "boolean"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"full_name": {
"type": [
"string",
"null"
]
},
"bio_cooked": {
"type": [
"string",
"null"
]
},
"user_count": {
"type": "integer"
},
"bio_excerpt": {
"type": [
"string",
"null"
]
},
"flair_color": {
"type": [
"string",
"null"
]
},
"public_exit": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"has_messages": {
"type": "boolean"
},
"is_group_user": {
"type": "boolean"
},
"primary_group": {
"type": "boolean"
},
"can_edit_group": {
"type": "boolean"
},
"flair_bg_color": {
"type": [
"string",
"null"
]
},
"incoming_email": {
"type": [
"string",
"null"
]
},
"is_group_owner": {
"type": "boolean"
},
"can_admin_group": {
"type": "boolean"
},
"can_see_members": {
"type": "boolean"
},
"public_admission": {
"type": "boolean"
},
"visibility_level": {
"type": "integer"
},
"grant_trust_level": {
"type": [
"string",
"null"
]
},
"mentionable_level": {
"type": "integer"
},
"messageable_level": {
"type": "integer"
},
"publish_read_state": {
"type": "boolean"
},
"members_visibility_level": {
"type": "integer"
},
"allow_membership_requests": {
"type": "boolean"
},
"default_notification_level": {
"type": "integer"
},
"membership_request_template": {
"type": [
"string",
"null"
]
}
}
}
},
"load_more_groups": {
"type": "string"
},
"total_rows_groups": {
"type": "integer"
}
},
"additionalProperties": false
}
GroupsRemoveMembersRequest
{
"properties": {
"usernames": {
"type": "string",
"example": "username1,username2",
"description": "comma separated list"
}
},
"additionalProperties": false
}
GroupsRemoveMembersResponse
{
"required": [
"success",
"usernames",
"skipped_usernames"
],
"properties": {
"success": {
"type": "string"
},
"usernames": {
"type": "array",
"items": {}
},
"skipped_usernames": {
"type": "array",
"items": {}
}
},
"additionalProperties": false
}
GroupsUpdateGroupByIdJsonRequest
{
"required": [
"group"
],
"properties": {
"group": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"bio_raw": {
"type": "string",
"description": "About Group"
},
"full_name": {
"type": "string"
},
"usernames": {
"type": "string",
"description": "comma,separated"
},
"flair_icon": {
"type": "string"
},
"public_exit": {
"type": "boolean"
},
"primary_group": {
"type": "boolean"
},
"flair_bg_color": {
"type": "string"
},
"flair_upload_id": {
"type": "integer"
},
"owner_usernames": {
"type": "string",
"description": "comma,separated"
},
"public_admission": {
"type": "boolean"
},
"visibility_level": {
"type": "integer"
},
"muted_category_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"regular_category_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"tracking_category_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"watching_category_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"default_notification_level": {
"type": "integer"
},
"watching_first_post_category_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"automatic_membership_email_domains": {
"type": "string",
"description": "pipe|separated"
}
}
}
},
"additionalProperties": false
}
GroupsUpdateGroupByIdJsonResponse
{
"type": "object",
"properties": {
"success": {
"type": "string",
"example": "OK"
}
}
}
InvitesCreateInviteRequest
{
"type": "object",
"properties": {
"email": {
"type": "string",
"example": "not-a-user-yet@example.com",
"description": "required for email invites only"
},
"topic_id": {
"type": "integer"
},
"group_ids": {
"type": "string",
"example": 4243,
"description": "Optional, either this or `group_names`. Comma separated\nlist for multiple ids."
},
"expires_at": {
"type": "string",
"description": "optional, if not supplied, the invite_expiry_days site\nsetting is used"
},
"skip_email": {
"type": "boolean",
"default": false
},
"group_names": {
"type": "string",
"example": "foo,bar",
"description": "Optional, either this or `group_ids`. Comma separated\nlist for multiple names."
},
"custom_message": {
"type": "string",
"description": "optional, for email invites"
},
"max_redemptions_allowed": {
"type": "integer",
"default": 1,
"example": 5,
"description": "optional, for link invites"
}
}
}
InvitesCreateInviteResponse
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 42
},
"link": {
"type": "string",
"example": "http://example.com/invites/9045fd767efe201ca60c6658bcf14158"
},
"email": {
"type": "string",
"example": "not-a-user-yet@example.com"
},
"groups": {
"type": "array",
"items": {},
"example": []
},
"topics": {
"type": "array",
"items": {},
"example": []
},
"emailed": {
"type": "boolean",
"example": false
},
"expired": {
"type": "boolean",
"example": false
},
"created_at": {
"type": "string",
"example": "2021-01-01T12:00:00.000Z"
},
"expires_at": {
"type": "string",
"example": "2021-02-01T12:00:00.000Z"
},
"updated_at": {
"type": "string",
"example": "2021-01-01T12:00:00.000Z"
},
"custom_message": {
"type": [
"string",
"null"
],
"example": "Hello world!"
}
}
}
InvitesCreateMultipleInvitesRequest
{
"type": "object",
"properties": {
"email": {
"type": "string",
"example": [
"not-a-user-yet-1@example.com",
"not-a-user-yet-2@example.com"
],
"description": "pass 1 email per invite to be generated. other properties\nwill be shared by each invite."
},
"topic_id": {
"type": "integer"
},
"group_ids": {
"type": "string",
"example": 4243,
"description": "Optional, either this or `group_names`. Comma separated\nlist for multiple ids."
},
"expires_at": {
"type": "string",
"description": "optional, if not supplied, the invite_expiry_days site\nsetting is used"
},
"skip_email": {
"type": "boolean",
"default": false
},
"group_names": {
"type": "string",
"example": "foo,bar",
"description": "Optional, either this or `group_ids`. Comma separated\nlist for multiple names."
},
"custom_message": {
"type": "string",
"description": "optional, for email invites"
},
"max_redemptions_allowed": {
"type": "integer",
"default": 1,
"example": 5,
"description": "optional, for link invites"
}
}
}
InvitesCreateMultipleInvitesResponse
{
"type": "object",
"properties": {
"failed_invitations": {
"type": "array",
"items": {},
"example": []
},
"num_failed_invitations": {
"type": "integer",
"example": 42
},
"successful_invitations": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
},
"example": [
{
"id": 42,
"link": "http://example.com/invites/9045fd767efe201ca60c6658bcf14158",
"email": "not-a-user-yet-1@example.com",
"groups": [],
"topics": [],
"emailed": true,
"expired": false,
"created_at": "2021-01-01T12:00:00.000Z",
"expires_at": "2021-02-01T12:00:00.000Z",
"updated_at": "2021-01-01T12:00:00.000Z",
"custom_message": "Hello world!"
},
{
"id": 42,
"link": "http://example.com/invites/c6658bcf141589045fd767efe201ca60",
"email": "not-a-user-yet-2@example.com",
"groups": [],
"topics": [],
"emailed": true,
"expired": false,
"created_at": "2021-01-01T12:00:00.000Z",
"expires_at": "2021-02-01T12:00:00.000Z",
"updated_at": "2021-01-01T12:00:00.000Z",
"custom_message": "Hello world!"
}
]
},
"num_successfully_created_invitations": {
"type": "integer",
"example": 42
}
}
}
NotificationsGetUserNotificationsResponse
{
"type": "object",
"properties": {
"notifications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"data": {
"type": "object",
"properties": {
"badge_id": {
"type": "integer"
},
"username": {
"type": "string"
},
"badge_name": {
"type": "string"
},
"badge_slug": {
"type": "string"
},
"badge_title": {
"type": "boolean"
}
}
},
"read": {
"type": "boolean"
},
"slug": {
"type": [
"string",
"null"
]
},
"user_id": {
"type": "integer"
},
"topic_id": {
"type": [
"integer",
"null"
]
},
"created_at": {
"type": "string"
},
"post_number": {
"type": [
"integer",
"null"
]
},
"notification_type": {
"type": "integer"
}
}
}
},
"seen_notification_id": {
"type": "integer"
},
"load_more_notifications": {
"type": "string"
},
"total_rows_notifications": {
"type": "integer"
}
}
}
NotificationsMarkAsReadRequest
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "(optional) Leave off to mark all notifications as\nread"
}
}
}
NotificationsMarkAsReadResponse
{
"type": "object",
"properties": {
"success": {
"type": "string"
}
}
}
PostsCreateTopicPostMessageRequest
{
"required": [
"raw"
],
"properties": {
"raw": {
"type": "string"
},
"title": {
"type": "string",
"description": "Required if creating a new topic or new private message."
},
"category": {
"type": "integer",
"description": "Optional if creating a new topic, and ignored if creating\na new post."
},
"topic_id": {
"type": "integer",
"description": "Required if creating a new post."
},
"archetype": {
"type": "string",
"example": "private_message",
"description": "Required for new private message."
},
"embed_url": {
"type": "string",
"description": "Provide a URL from a remote system to associate a forum\ntopic with that URL, typically for using Discourse as a comments\nsystem for an external blog."
},
"created_at": {
"type": "string"
},
"external_id": {
"type": "string",
"description": "Provide an external_id from a remote system to associate\na forum topic with that id."
},
"target_usernames": {
"type": "string",
"deprecated": true,
"description": "Deprecated. Use target_recipients instead."
},
"target_recipients": {
"type": "string",
"example": "blake,sam",
"description": "Required for private message, comma separated."
},
"reply_to_post_number": {
"type": "integer",
"description": "Optional, the post number to reply to inside a topic."
}
},
"additionalProperties": false
}
PostsCreateTopicPostMessageResponse
{
"required": [
"id",
"name",
"username",
"avatar_template",
"created_at",
"cooked",
"post_number",
"post_type",
"updated_at",
"reply_count",
"reply_to_post_number",
"quote_count",
"incoming_link_count",
"reads",
"readers_count",
"score",
"yours",
"topic_id",
"topic_slug",
"display_username",
"primary_group_name",
"flair_name",
"flair_url",
"flair_bg_color",
"flair_color",
"version",
"can_edit",
"can_delete",
"can_recover",
"can_wiki",
"user_title",
"bookmarked",
"actions_summary",
"moderator",
"admin",
"staff",
"user_id",
"draft_sequence",
"hidden",
"trust_level",
"deleted_at",
"user_deleted",
"edit_reason",
"can_view_edit_history",
"wiki",
"reviewable_id",
"reviewable_score_count",
"reviewable_score_pending_count"
],
"properties": {
"id": {
"type": "integer"
},
"raw": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"wiki": {
"type": "boolean"
},
"admin": {
"type": "boolean"
},
"reads": {
"type": "integer"
},
"score": {
"type": "number"
},
"staff": {
"type": "boolean"
},
"yours": {
"type": "boolean"
},
"cooked": {
"type": "string"
},
"hidden": {
"type": "boolean"
},
"user_id": {
"type": "integer"
},
"version": {
"type": "integer"
},
"can_edit": {
"type": "boolean"
},
"can_wiki": {
"type": "boolean"
},
"topic_id": {
"type": "integer"
},
"username": {
"type": "string"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"moderator": {
"type": "boolean"
},
"post_type": {
"type": "integer"
},
"bookmarked": {
"type": "boolean"
},
"can_delete": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"deleted_at": {
"type": [
"string",
"null"
]
},
"flair_name": {
"type": [
"string",
"null"
]
},
"topic_slug": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user_title": {
"type": [
"string",
"null"
]
},
"can_recover": {
"type": "boolean"
},
"edit_reason": {
"type": [
"string",
"null"
]
},
"flair_color": {
"type": [
"string",
"null"
]
},
"post_number": {
"type": "integer"
},
"quote_count": {
"type": "integer"
},
"reply_count": {
"type": "integer"
},
"trust_level": {
"type": "integer"
},
"user_deleted": {
"type": "boolean"
},
"readers_count": {
"type": "integer"
},
"reviewable_id": {
"type": [
"string",
"null"
]
},
"draft_sequence": {
"type": "integer"
},
"flair_bg_color": {
"type": [
"string",
"null"
]
},
"flair_group_id": {
"type": [
"string",
"null"
]
},
"actions_summary": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"can_act"
],
"properties": {
"id": {
"type": "integer"
},
"can_act": {
"type": "boolean"
}
}
}
},
"avatar_template": {
"type": "string"
},
"mentioned_users": {
"type": "array",
"items": {}
},
"display_username": {
"type": [
"string",
"null"
]
},
"primary_group_name": {
"type": [
"string",
"null"
]
},
"can_see_hidden_post": {
"type": "boolean"
},
"incoming_link_count": {
"type": "integer"
},
"reply_to_post_number": {
"type": [
"string",
"null"
]
},
"can_view_edit_history": {
"type": "boolean"
},
"reviewable_score_count": {
"type": "integer"
},
"reviewable_score_pending_count": {
"type": "integer"
}
},
"additionalProperties": false
}
PostsDeleteSinglePostRequest
{
"properties": {
"force_destroy": {
"type": "boolean",
"example": true,
"description": "The `SiteSetting.can_permanently_delete` needs to be\nenabled first before this param can be used. Also this endpoint\nneeds to be called first without `force_destroy` and then followed\nup with a second call 5 minutes later with `force_destroy` to\npermanently delete."
}
},
"additionalProperties": false
}
PostsGetSinglePostLikesResponse
{
"required": [
"id",
"username",
"avatar_template",
"created_at",
"cooked",
"post_number",
"post_type",
"updated_at",
"reply_count",
"reply_to_post_number",
"quote_count",
"incoming_link_count",
"reads",
"readers_count",
"score",
"yours",
"topic_id",
"topic_slug",
"primary_group_name",
"flair_name",
"flair_url",
"flair_bg_color",
"flair_color",
"version",
"can_edit",
"can_delete",
"can_recover",
"can_wiki",
"user_title",
"bookmarked",
"raw",
"actions_summary",
"moderator",
"admin",
"staff",
"user_id",
"hidden",
"trust_level",
"deleted_at",
"user_deleted",
"edit_reason",
"can_view_edit_history",
"wiki",
"reviewable_id",
"reviewable_score_count",
"reviewable_score_pending_count"
],
"properties": {
"id": {
"type": "integer"
},
"raw": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"wiki": {
"type": "boolean"
},
"admin": {
"type": "boolean"
},
"reads": {
"type": "integer"
},
"score": {
"type": "number"
},
"staff": {
"type": "boolean"
},
"yours": {
"type": "boolean"
},
"cooked": {
"type": "string"
},
"hidden": {
"type": "boolean"
},
"user_id": {
"type": "integer"
},
"version": {
"type": "integer"
},
"can_edit": {
"type": "boolean"
},
"can_wiki": {
"type": "boolean"
},
"topic_id": {
"type": "integer"
},
"username": {
"type": "string"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"moderator": {
"type": "boolean"
},
"post_type": {
"type": "integer"
},
"bookmarked": {
"type": "boolean"
},
"can_delete": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"deleted_at": {
"type": [
"string",
"null"
]
},
"flair_name": {
"type": [
"string",
"null"
]
},
"topic_slug": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user_title": {
"type": [
"string",
"null"
]
},
"can_recover": {
"type": "boolean"
},
"edit_reason": {
"type": [
"string",
"null"
]
},
"flair_color": {
"type": [
"string",
"null"
]
},
"post_number": {
"type": "integer"
},
"quote_count": {
"type": "integer"
},
"reply_count": {
"type": "integer"
},
"trust_level": {
"type": "integer"
},
"user_deleted": {
"type": "boolean"
},
"readers_count": {
"type": "integer"
},
"reviewable_id": {
"type": [
"string",
"null"
]
},
"flair_bg_color": {
"type": [
"string",
"null"
]
},
"flair_group_id": {
"type": [
"string",
"null"
]
},
"actions_summary": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "`2`: like, `3`, `4`, `6`, `7`, `8`: flag"
},
"acted": {
"type": "boolean"
},
"count": {
"type": "integer"
},
"can_act": {
"type": "boolean"
},
"can_undo": {
"type": "boolean"
}
}
}
},
"avatar_template": {
"type": "string"
},
"mentioned_users": {
"type": "array",
"items": {}
},
"display_username": {
"type": [
"string",
"null"
]
},
"primary_group_name": {
"type": [
"string",
"null"
]
},
"can_see_hidden_post": {
"type": "boolean"
},
"incoming_link_count": {
"type": "integer"
},
"reply_to_post_number": {
"type": [
"string",
"null"
]
},
"can_view_edit_history": {
"type": "boolean"
},
"reviewable_score_count": {
"type": "integer"
},
"reviewable_score_pending_count": {
"type": "integer"
}
},
"additionalProperties": true
}
PostsLikePostActionRequest
{
"type": "object",
"required": [
"id",
"post_action_type_id"
],
"properties": {
"id": {
"type": "integer"
},
"flag_topic": {
"type": "boolean"
},
"post_action_type_id": {
"type": "integer"
}
}
}
PostsLikePostActionResponse
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"wiki": {
"type": "boolean"
},
"admin": {
"type": "boolean"
},
"reads": {
"type": "integer"
},
"score": {
"type": "number"
},
"staff": {
"type": "boolean"
},
"yours": {
"type": "boolean"
},
"cooked": {
"type": "string"
},
"hidden": {
"type": "boolean"
},
"notice": {
"type": "object"
},
"user_id": {
"type": "integer"
},
"version": {
"type": "integer"
},
"can_edit": {
"type": "boolean"
},
"can_wiki": {
"type": "boolean"
},
"topic_id": {
"type": "integer"
},
"username": {
"type": "string"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"moderator": {
"type": "boolean"
},
"post_type": {
"type": "integer"
},
"can_delete": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"deleted_at": {
"type": [
"string",
"null"
]
},
"flair_name": {
"type": [
"string",
"null"
]
},
"topic_slug": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user_title": {
"type": [
"string",
"null"
]
},
"can_recover": {
"type": "boolean"
},
"edit_reason": {
"type": [
"string",
"null"
]
},
"flair_color": {
"type": [
"string",
"null"
]
},
"post_number": {
"type": "integer"
},
"quote_count": {
"type": "integer"
},
"reply_count": {
"type": "integer"
},
"trust_level": {
"type": "integer"
},
"user_deleted": {
"type": "boolean"
},
"readers_count": {
"type": "integer"
},
"reviewable_id": {
"type": [
"string",
"null"
]
},
"flair_bg_color": {
"type": [
"string",
"null"
]
},
"actions_summary": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"acted": {
"type": "boolean"
},
"count": {
"type": "integer"
},
"can_undo": {
"type": "boolean"
}
}
}
},
"avatar_template": {
"type": "string"
},
"display_username": {
"type": "string"
},
"primary_group_name": {
"type": [
"string",
"null"
]
},
"incoming_link_count": {
"type": "integer"
},
"reply_to_post_number": {
"type": [
"string",
"null"
]
},
"can_view_edit_history": {
"type": "boolean"
},
"reviewable_score_count": {
"type": "integer"
},
"reviewable_score_pending_count": {
"type": "integer"
}
}
}
PostsListLatestPostsAcrossTopicsResponse
{
"type": "object",
"properties": {
"latest_posts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"raw": {
"type": "string"
},
"name": {
"type": "string"
},
"wiki": {
"type": "boolean"
},
"admin": {
"type": "boolean"
},
"reads": {
"type": "integer"
},
"score": {
"type": "number"
},
"staff": {
"type": "boolean"
},
"yours": {
"type": "boolean"
},
"cooked": {
"type": "string"
},
"hidden": {
"type": "boolean"
},
"user_id": {
"type": "integer"
},
"version": {
"type": "integer"
},
"can_edit": {
"type": "boolean"
},
"can_wiki": {
"type": "boolean"
},
"topic_id": {
"type": "integer"
},
"username": {
"type": "string"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"moderator": {
"type": "boolean"
},
"post_type": {
"type": "integer"
},
"can_delete": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"deleted_at": {
"type": [
"string",
"null"
]
},
"flair_name": {
"type": [
"string",
"null"
]
},
"topic_slug": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user_title": {
"type": [
"string",
"null"
]
},
"can_recover": {
"type": "boolean"
},
"category_id": {
"type": "integer"
},
"edit_reason": {
"type": [
"string",
"null"
]
},
"flair_color": {
"type": [
"string",
"null"
]
},
"post_number": {
"type": "integer"
},
"quote_count": {
"type": "integer"
},
"reply_count": {
"type": "integer"
},
"topic_title": {
"type": "string"
},
"trust_level": {
"type": "integer"
},
"user_deleted": {
"type": "boolean"
},
"readers_count": {
"type": "integer"
},
"reviewable_id": {
"type": [
"string",
"null"
]
},
"flair_bg_color": {
"type": [
"string",
"null"
]
},
"flair_group_id": {
"type": [
"string",
"null"
]
},
"actions_summary": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"can_act": {
"type": "boolean"
}
}
}
},
"avatar_template": {
"type": "string"
},
"display_username": {
"type": "string"
},
"topic_html_title": {
"type": "string"
},
"primary_group_name": {
"type": [
"string",
"null"
]
},
"can_see_hidden_post": {
"type": "boolean"
},
"incoming_link_count": {
"type": "integer"
},
"reply_to_post_number": {
"type": [
"string",
"null"
]
},
"can_view_edit_history": {
"type": "boolean"
},
"reviewable_score_count": {
"type": "integer"
},
"reviewable_score_pending_count": {
"type": "integer"
}
}
}
}
}
}
PostsListRepliesToPostResponse
{
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"username",
"avatar_template",
"created_at",
"cooked",
"post_number",
"post_type",
"updated_at",
"reply_count",
"reply_to_post_number",
"quote_count",
"incoming_link_count",
"reads",
"readers_count",
"score",
"yours",
"topic_id",
"topic_slug",
"display_username",
"primary_group_name",
"flair_name",
"flair_url",
"flair_bg_color",
"flair_color",
"version",
"can_edit",
"can_delete",
"can_recover",
"can_see_hidden_post",
"can_wiki",
"user_title",
"reply_to_user",
"bookmarked",
"actions_summary",
"moderator",
"admin",
"staff",
"user_id",
"hidden",
"trust_level",
"deleted_at",
"user_deleted",
"edit_reason",
"can_view_edit_history",
"wiki",
"reviewable_id",
"reviewable_score_count",
"reviewable_score_pending_count"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": [
"string",
"null"
]
},
"wiki": {
"type": "boolean"
},
"admin": {
"type": "boolean"
},
"reads": {
"type": "integer"
},
"score": {
"type": "number"
},
"staff": {
"type": "boolean"
},
"yours": {
"type": "boolean"
},
"cooked": {
"type": "string"
},
"hidden": {
"type": "boolean"
},
"user_id": {
"type": "integer"
},
"version": {
"type": "integer"
},
"can_edit": {
"type": "boolean"
},
"can_wiki": {
"type": "boolean"
},
"topic_id": {
"type": "integer"
},
"username": {
"type": "string"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"moderator": {
"type": "boolean"
},
"post_type": {
"type": "integer"
},
"bookmarked": {
"type": "boolean"
},
"can_delete": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"deleted_at": {
"type": [
"string",
"null"
]
},
"flair_name": {
"type": [
"string",
"null"
]
},
"topic_slug": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user_title": {
"type": [
"string",
"null"
]
},
"can_recover": {
"type": "boolean"
},
"edit_reason": {
"type": [
"string",
"null"
]
},
"flair_color": {
"type": [
"string",
"null"
]
},
"post_number": {
"type": "integer"
},
"quote_count": {
"type": "integer"
},
"reply_count": {
"type": "integer"
},
"trust_level": {
"type": "integer"
},
"user_deleted": {
"type": "boolean"
},
"readers_count": {
"type": "integer"
},
"reply_to_user": {
"type": "object",
"required": [
"username",
"avatar_template"
],
"properties": {
"name": {
"type": "string"
},
"username": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
}
},
"reviewable_id": {
"type": [
"string",
"null"
]
},
"flair_bg_color": {
"type": [
"string",
"null"
]
},
"flair_group_id": {
"type": [
"string",
"null"
]
},
"actions_summary": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"can_act"
],
"properties": {
"id": {
"type": "integer"
},
"can_act": {
"type": "boolean"
}
}
}
},
"avatar_template": {
"type": "string"
},
"display_username": {
"type": [
"string",
"null"
]
},
"primary_group_name": {
"type": [
"string",
"null"
]
},
"can_see_hidden_post": {
"type": "boolean"
},
"incoming_link_count": {
"type": "integer"
},
"reply_to_post_number": {
"type": "integer"
},
"can_view_edit_history": {
"type": "boolean"
},
"reviewable_score_count": {
"type": "integer"
},
"reviewable_score_pending_count": {
"type": "integer"
}
}
},
"minItems": 1,
"uniqueItems": true
}
PostsLockPostActionRequest
{
"type": "object",
"required": [
"locked"
],
"properties": {
"locked": {
"type": "string"
}
}
}
PostsLockPostActionResponse
{
"type": "object",
"properties": {
"locked": {
"type": "boolean"
}
}
}
PostsUpdateSinglePostJsonRequest
{
"properties": {
"post": {
"type": "object",
"required": [
"raw"
],
"properties": {
"raw": {
"type": "string"
},
"edit_reason": {
"type": "string"
}
}
}
},
"additionalProperties": false
}
PostsUpdateSinglePostJsonResponse
{
"required": [
"post"
],
"properties": {
"post": {
"type": "object",
"required": [
"id",
"username",
"avatar_template",
"created_at",
"cooked",
"post_number",
"post_type",
"updated_at",
"reply_count",
"reply_to_post_number",
"quote_count",
"incoming_link_count",
"reads",
"readers_count",
"score",
"yours",
"topic_id",
"topic_slug",
"primary_group_name",
"flair_name",
"flair_url",
"flair_bg_color",
"flair_color",
"version",
"can_edit",
"can_delete",
"can_recover",
"can_wiki",
"user_title",
"bookmarked",
"raw",
"actions_summary",
"moderator",
"admin",
"staff",
"user_id",
"draft_sequence",
"hidden",
"trust_level",
"deleted_at",
"user_deleted",
"edit_reason",
"can_view_edit_history",
"wiki",
"reviewable_id",
"reviewable_score_count",
"reviewable_score_pending_count"
],
"properties": {
"id": {
"type": "integer"
},
"raw": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"wiki": {
"type": "boolean"
},
"admin": {
"type": "boolean"
},
"reads": {
"type": "integer"
},
"score": {
"type": "number"
},
"staff": {
"type": "boolean"
},
"yours": {
"type": "boolean"
},
"cooked": {
"type": "string"
},
"hidden": {
"type": "boolean"
},
"user_id": {
"type": "integer"
},
"version": {
"type": "integer"
},
"can_edit": {
"type": "boolean"
},
"can_wiki": {
"type": "boolean"
},
"topic_id": {
"type": "integer"
},
"username": {
"type": "string"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"moderator": {
"type": "boolean"
},
"post_type": {
"type": "integer"
},
"bookmarked": {
"type": "boolean"
},
"can_delete": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"deleted_at": {
"type": [
"string",
"null"
]
},
"flair_name": {
"type": [
"string",
"null"
]
},
"topic_slug": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user_title": {
"type": [
"string",
"null"
]
},
"can_recover": {
"type": "boolean"
},
"edit_reason": {
"type": [
"string",
"null"
]
},
"flair_color": {
"type": [
"string",
"null"
]
},
"post_number": {
"type": "integer"
},
"quote_count": {
"type": "integer"
},
"reply_count": {
"type": "integer"
},
"trust_level": {
"type": "integer"
},
"user_deleted": {
"type": "boolean"
},
"readers_count": {
"type": "integer"
},
"reviewable_id": {
"type": [
"string",
"null"
]
},
"draft_sequence": {
"type": "integer"
},
"flair_bg_color": {
"type": [
"string",
"null"
]
},
"flair_group_id": {
"type": [
"string",
"null"
]
},
"actions_summary": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"can_act"
],
"properties": {
"id": {
"type": "integer"
},
"can_act": {
"type": "boolean"
}
}
}
},
"avatar_template": {
"type": "string"
},
"mentioned_users": {
"type": "array",
"items": {}
},
"display_username": {
"type": [
"string",
"null"
]
},
"primary_group_name": {
"type": [
"string",
"null"
]
},
"can_see_hidden_post": {
"type": "boolean"
},
"incoming_link_count": {
"type": "integer"
},
"reply_to_post_number": {
"type": [
"string",
"null"
]
},
"can_view_edit_history": {
"type": "boolean"
},
"reviewable_score_count": {
"type": "integer"
},
"reviewable_score_pending_count": {
"type": "integer"
}
}
}
},
"additionalProperties": false
}
PrivateMessagesListForUserResponse
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"username": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
}
}
},
"topic_list": {
"type": "object",
"properties": {
"draft": {
"type": [
"string",
"null"
]
},
"topics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"slug": {
"type": "string"
},
"liked": {
"type": "boolean"
},
"title": {
"type": "string"
},
"views": {
"type": "integer"
},
"bumped": {
"type": "boolean"
},
"closed": {
"type": "boolean"
},
"pinned": {
"type": "boolean"
},
"unseen": {
"type": "boolean"
},
"posters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"extras": {
"type": "string"
},
"user_id": {
"type": "integer"
},
"description": {
"type": "string"
},
"primary_group_id": {
"type": [
"string",
"null"
]
}
}
}
},
"visible": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"unpinned": {
"type": [
"string",
"null"
]
},
"archetype": {
"type": "string"
},
"bumped_at": {
"type": "string"
},
"image_url": {
"type": [
"string",
"null"
]
},
"bookmarked": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"like_count": {
"type": "integer"
},
"category_id": {
"type": [
"string",
"null"
]
},
"fancy_title": {
"type": "string"
},
"has_summary": {
"type": "boolean"
},
"posts_count": {
"type": "integer"
},
"reply_count": {
"type": "integer"
},
"participants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"extras": {
"type": "string"
},
"user_id": {
"type": "integer"
},
"description": {
"type": [
"string",
"null"
]
},
"primary_group_id": {
"type": [
"string",
"null"
]
}
}
}
},
"unread_posts": {
"type": "integer"
},
"featured_link": {
"type": [
"string",
"null"
]
},
"last_posted_at": {
"type": "string"
},
"pinned_globally": {
"type": "boolean"
},
"allowed_user_count": {
"type": "integer"
},
"notification_level": {
"type": "integer"
},
"highest_post_number": {
"type": "integer"
},
"last_poster_username": {
"type": "string"
},
"last_read_post_number": {
"type": "integer"
}
}
}
},
"per_page": {
"type": "integer"
},
"draft_key": {
"type": "string"
},
"draft_sequence": {
"type": "integer"
},
"can_create_topic": {
"type": "boolean"
}
}
},
"primary_groups": {
"type": "array",
"items": {}
}
}
}
PrivateMessagesListSentForUserResponse
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": [
"string",
"null"
]
},
"username": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
}
}
},
"topic_list": {
"type": "object",
"properties": {
"draft": {
"type": [
"string",
"null"
]
},
"topics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"slug": {
"type": "string"
},
"liked": {
"type": "boolean"
},
"title": {
"type": "string"
},
"views": {
"type": "integer"
},
"bumped": {
"type": "boolean"
},
"closed": {
"type": "boolean"
},
"pinned": {
"type": "boolean"
},
"unseen": {
"type": "boolean"
},
"posters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"extras": {
"type": "string"
},
"user_id": {
"type": "integer"
},
"description": {
"type": "string"
},
"primary_group_id": {
"type": [
"string",
"null"
]
}
}
}
},
"visible": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"unpinned": {
"type": [
"string",
"null"
]
},
"archetype": {
"type": "string"
},
"bumped_at": {
"type": "string"
},
"image_url": {
"type": [
"string",
"null"
]
},
"bookmarked": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"like_count": {
"type": "integer"
},
"category_id": {
"type": [
"string",
"null"
]
},
"fancy_title": {
"type": "string"
},
"has_summary": {
"type": "boolean"
},
"posts_count": {
"type": "integer"
},
"reply_count": {
"type": "integer"
},
"participants": {
"type": "array",
"items": {}
},
"unread_posts": {
"type": "integer"
},
"featured_link": {
"type": [
"string",
"null"
]
},
"last_posted_at": {
"type": "string"
},
"pinned_globally": {
"type": "boolean"
},
"allowed_user_count": {
"type": "integer"
},
"notification_level": {
"type": "integer"
},
"highest_post_number": {
"type": "integer"
},
"last_poster_username": {
"type": "string"
},
"last_read_post_number": {
"type": "integer"
}
}
}
},
"per_page": {
"type": "integer"
},
"draft_key": {
"type": "string"
},
"draft_sequence": {
"type": "integer"
},
"can_create_topic": {
"type": "boolean"
}
}
},
"primary_groups": {
"type": "array",
"items": {}
}
}
}
SearchTermResultsResponse
{
"required": [
"posts",
"users",
"categories",
"tags",
"groups",
"grouped_search_result"
],
"properties": {
"tags": {
"type": "array",
"items": {}
},
"posts": {
"type": "array",
"items": {}
},
"users": {
"type": "array",
"items": {}
},
"groups": {
"type": "array",
"items": {}
},
"categories": {
"type": "array",
"items": {}
},
"grouped_search_result": {
"type": "object",
"required": [
"more_posts",
"more_users",
"more_categories",
"term",
"search_log_id",
"more_full_page_results",
"can_create_topic",
"error",
"post_ids",
"user_ids",
"category_ids",
"tag_ids",
"group_ids"
],
"properties": {
"term": {
"type": "string"
},
"error": {
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {
"categories": {
"type": [
"array",
"null"
]
}
}
},
"tag_ids": {
"type": "array",
"items": {}
},
"post_ids": {
"type": "array",
"items": {}
},
"user_ids": {
"type": "array",
"items": {}
},
"group_ids": {
"type": "array",
"items": {}
},
"more_posts": {
"type": [
"string",
"null"
]
},
"more_users": {
"type": [
"string",
"null"
]
},
"category_ids": {
"type": "array",
"items": {}
},
"search_log_id": {
"type": "integer"
},
"more_categories": {
"type": [
"string",
"null"
]
},
"can_create_topic": {
"type": "boolean"
},
"more_full_page_results": {
"type": [
"string",
"null"
]
}
}
}
},
"additionalProperties": false
}
SiteGetBasicInfoResponse
{
"required": [
"logo_url",
"logo_small_url",
"apple_touch_icon_url",
"favicon_url",
"title",
"description",
"header_primary_color",
"header_background_color",
"login_required",
"mobile_logo_url"
],
"properties": {
"title": {
"type": "string"
},
"logo_url": {
"type": "string"
},
"description": {
"type": "string"
},
"favicon_url": {
"type": "string"
},
"login_required": {
"type": "boolean"
},
"logo_small_url": {
"type": "string"
},
"mobile_logo_url": {
"type": "string"
},
"apple_touch_icon_url": {
"type": "string"
},
"header_primary_color": {
"type": "string"
},
"header_background_color": {
"type": "string"
}
},
"additionalProperties": false
}
SiteGetCategoriesAndSubcategoriesResponse
{
"required": [
"default_archetype",
"notification_types",
"post_types",
"trust_levels",
"groups",
"filters",
"periods",
"top_menu_items",
"anonymous_top_menu_items",
"uncategorized_category_id",
"user_field_max_length",
"post_action_types",
"topic_flag_types",
"can_create_tag",
"can_tag_topics",
"can_tag_pms",
"tags_filter_regexp",
"top_tags",
"topic_featured_link_allowed_category_ids",
"user_themes",
"user_color_schemes",
"default_dark_color_scheme",
"censored_regexp",
"custom_emoji_translation",
"watched_words_replace",
"watched_words_link",
"categories",
"archetypes",
"user_fields",
"auth_providers"
],
"properties": {
"groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"flair_url",
"flair_bg_color",
"flair_color"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"flair_color": {
"type": [
"string",
"null"
]
},
"flair_bg_color": {
"type": [
"string",
"null"
]
}
}
}
},
"filters": {
"type": "array",
"items": {}
},
"periods": {
"type": "array",
"items": {}
},
"top_tags": {
"type": "array",
"items": {}
},
"user_tips": {
"type": "object",
"required": [
"first_notification",
"topic_timeline",
"post_menu",
"topic_notification_levels",
"suggested_topics",
"admin_guide"
],
"properties": {
"post_menu": {
"type": "integer"
},
"admin_guide": {
"type": "integer"
},
"topic_timeline": {
"type": "integer"
},
"suggested_topics": {
"type": "integer"
},
"first_notification": {
"type": "integer"
},
"topic_notification_levels": {
"type": "integer"
}
}
},
"archetypes": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"options"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"options": {
"type": "array",
"items": {}
}
}
}
},
"categories": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"color",
"text_color",
"slug",
"topic_count",
"post_count",
"position",
"topic_url",
"read_restricted",
"permission",
"notification_level",
"topic_template",
"has_children",
"sort_order",
"sort_ascending",
"show_subcategory_list",
"num_featured_topics",
"default_view",
"subcategory_list_style",
"default_top_period",
"default_list_filter",
"minimum_required_tags",
"navigate_to_first_post_after_read",
"allowed_tags",
"allowed_tag_groups",
"allow_global_tags",
"required_tag_groups",
"read_only_banner",
"uploaded_logo",
"uploaded_logo_dark",
"uploaded_background",
"uploaded_background_dark",
"can_edit"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"color": {
"type": "string"
},
"can_edit": {
"type": "boolean"
},
"position": {
"type": "integer"
},
"topic_url": {
"type": "string"
},
"permission": {
"type": "integer"
},
"post_count": {
"type": "integer"
},
"sort_order": {
"type": [
"string",
"null"
]
},
"text_color": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"topic_count": {
"type": "integer"
},
"allowed_tags": {
"type": "array",
"items": {}
},
"default_view": {
"type": [
"string",
"null"
]
},
"has_children": {
"type": "boolean"
},
"custom_fields": {
"type": [
"object",
"null"
],
"additionalProperties": true
},
"uploaded_logo": {
"type": [
"string",
"null"
]
},
"sort_ascending": {
"type": [
"string",
"null"
]
},
"topic_template": {
"type": [
"string",
"null"
]
},
"read_restricted": {
"type": "boolean"
},
"description_text": {
"type": [
"string",
"null"
]
},
"read_only_banner": {
"type": [
"string",
"null"
]
},
"allow_global_tags": {
"type": "boolean"
},
"form_template_ids": {
"type": "array",
"items": {}
},
"allowed_tag_groups": {
"type": "array",
"items": {}
},
"default_top_period": {
"type": "string"
},
"notification_level": {
"type": "integer"
},
"parent_category_id": {
"type": "integer"
},
"uploaded_logo_dark": {
"type": [
"string",
"null"
]
},
"default_list_filter": {
"type": "string"
},
"description_excerpt": {
"type": [
"string",
"null"
]
},
"num_featured_topics": {
"type": "integer"
},
"required_tag_groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"min_count"
],
"properties": {
"name": {
"type": "string"
},
"min_count": {
"type": "integer"
}
}
}
},
"uploaded_background": {
"type": [
"string",
"null"
]
},
"minimum_required_tags": {
"type": "integer"
},
"show_subcategory_list": {
"type": "boolean"
},
"subcategory_list_style": {
"type": "string"
},
"uploaded_background_dark": {
"type": [
"string",
"null"
]
},
"navigate_to_first_post_after_read": {
"type": "boolean"
}
}
}
},
"post_types": {
"type": "object",
"required": [
"regular",
"moderator_action",
"small_action",
"whisper"
],
"properties": {
"regular": {
"type": "integer"
},
"whisper": {
"type": "integer"
},
"small_action": {
"type": "integer"
},
"moderator_action": {
"type": "integer"
}
}
},
"can_tag_pms": {
"type": "boolean"
},
"user_fields": {
"type": "array",
"items": {}
},
"user_themes": {
"type": "array",
"items": {
"type": "object",
"required": [
"theme_id",
"name",
"default",
"color_scheme_id"
],
"properties": {
"name": {
"type": "string"
},
"default": {
"type": "boolean"
},
"theme_id": {
"type": "integer"
},
"color_scheme_id": {
"type": [
"integer",
"null"
]
}
}
}
},
"trust_levels": {
"type": "object",
"required": [
"newuser",
"basic",
"member",
"regular",
"leader"
],
"properties": {
"basic": {
"type": "integer"
},
"leader": {
"type": "integer"
},
"member": {
"type": "integer"
},
"newuser": {
"type": "integer"
},
"regular": {
"type": "integer"
}
}
},
"denied_emojis": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
}
},
"hashtag_icons": {
"type": "object"
},
"auth_providers": {
"type": "array",
"items": {}
},
"can_create_tag": {
"type": "boolean"
},
"can_tag_topics": {
"type": "boolean"
},
"top_menu_items": {
"type": "array",
"items": {}
},
"censored_regexp": {
"type": "array",
"items": {
"type": "object"
}
},
"wizard_required": {
"type": "boolean"
},
"topic_flag_types": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name_key",
"name",
"description",
"short_description",
"is_flag",
"is_custom_flag"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"name": {
"type": "string"
},
"is_flag": {
"type": "boolean"
},
"name_key": {
"type": [
"string",
"null"
]
},
"description": {
"type": "string"
},
"is_custom_flag": {
"type": "boolean"
},
"short_description": {
"type": "string"
}
}
}
},
"default_archetype": {
"type": "string"
},
"post_action_types": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name_key",
"name",
"description",
"short_description",
"is_flag",
"is_custom_flag"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"name": {
"type": "string"
},
"is_flag": {
"type": "boolean"
},
"name_key": {
"type": [
"string",
"null"
]
},
"description": {
"type": "string"
},
"is_custom_flag": {
"type": "boolean"
},
"short_description": {
"type": "string"
}
}
}
},
"notification_types": {
"type": "object",
"required": [
"mentioned",
"replied",
"quoted",
"edited",
"liked",
"private_message",
"invited_to_private_message",
"invitee_accepted",
"posted",
"watching_category_or_tag",
"moved_post",
"linked",
"granted_badge",
"invited_to_topic",
"custom",
"group_mentioned",
"group_message_summary",
"watching_first_post",
"topic_reminder",
"liked_consolidated",
"linked_consolidated",
"post_approved",
"code_review_commit_approved",
"membership_request_accepted",
"membership_request_consolidated",
"bookmark_reminder",
"reaction",
"votes_released",
"event_reminder",
"event_invitation",
"chat_mention",
"chat_message",
"chat_invitation",
"chat_group_mention"
],
"properties": {
"liked": {
"type": "integer"
},
"custom": {
"type": "integer"
},
"edited": {
"type": "integer"
},
"linked": {
"type": "integer"
},
"posted": {
"type": "integer"
},
"quoted": {
"type": "integer"
},
"replied": {
"type": "integer"
},
"assigned": {
"type": "integer"
},
"reaction": {
"type": "integer"
},
"following": {
"type": "integer"
},
"mentioned": {
"type": "integer"
},
"moved_post": {
"type": "integer"
},
"chat_quoted": {
"type": "integer"
},
"chat_mention": {
"type": "integer"
},
"chat_message": {
"type": "integer"
},
"new_features": {
"type": "integer"
},
"granted_badge": {
"type": "integer"
},
"post_approved": {
"type": "integer"
},
"admin_problems": {
"type": "integer"
},
"event_reminder": {
"type": "integer"
},
"topic_reminder": {
"type": "integer"
},
"votes_released": {
"type": "integer"
},
"chat_invitation": {
"type": "integer"
},
"group_mentioned": {
"type": "integer"
},
"private_message": {
"type": "integer"
},
"circles_activity": {
"type": "integer"
},
"event_invitation": {
"type": "integer"
},
"invited_to_topic": {
"type": "integer"
},
"invitee_accepted": {
"type": "integer"
},
"bookmark_reminder": {
"type": "integer"
},
"following_replied": {
"type": "integer"
},
"chat_group_mention": {
"type": "integer"
},
"liked_consolidated": {
"type": "integer"
},
"linked_consolidated": {
"type": "integer"
},
"watching_first_post": {
"type": "integer"
},
"group_message_summary": {
"type": "integer"
},
"following_created_topic": {
"type": "integer"
},
"watching_category_or_tag": {
"type": "integer"
},
"invited_to_private_message": {
"type": "integer"
},
"code_review_commit_approved": {
"type": "integer"
},
"membership_request_accepted": {
"type": "integer"
},
"question_answer_user_commented": {
"type": "integer"
},
"membership_request_consolidated": {
"type": "integer"
}
}
},
"tags_filter_regexp": {
"type": "string"
},
"user_color_schemes": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"is_dark"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"is_dark": {
"type": "boolean"
}
}
}
},
"watched_words_link": {
"type": [
"string",
"null"
]
},
"can_associate_groups": {
"type": "boolean"
},
"user_field_max_length": {
"type": "integer"
},
"watched_words_replace": {
"type": [
"string",
"null"
]
},
"hashtag_configurations": {
"type": "object"
},
"anonymous_top_menu_items": {
"type": "array",
"items": {}
},
"custom_emoji_translation": {
"type": "object",
"properties": {}
},
"default_dark_color_scheme": {
"type": [
"object",
"null"
]
},
"uncategorized_category_id": {
"type": "integer"
},
"markdown_additional_options": {
"type": "object"
},
"navigation_menu_site_top_tags": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
}
},
"whispers_allowed_groups_names": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
}
},
"displayed_about_plugin_stat_groups": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
}
},
"topic_featured_link_allowed_category_ids": {
"type": "array",
"items": {}
}
},
"additionalProperties": false
}
TagsCreateTagGroupRequest
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
}
}
}
TagsCreateTagGroupResponse
{
"type": "object",
"required": [
"tag_group"
],
"properties": {
"tag_group": {
"type": "object",
"required": [
"id",
"name",
"tag_names",
"parent_tag_name",
"one_per_topic",
"permissions"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"tag_names": {
"type": "array",
"items": {}
},
"permissions": {
"type": "object"
},
"one_per_topic": {
"type": "boolean"
},
"parent_tag_name": {
"type": "array",
"items": {}
}
}
}
}
}
TagsGetSingleTagGroupResponse
{
"type": "object",
"properties": {
"tag_group": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"tag_names": {
"type": "array",
"items": {}
},
"permissions": {
"type": "object",
"properties": {
"everyone": {
"type": "integer"
}
}
},
"one_per_topic": {
"type": "boolean"
},
"parent_tag_name": {
"type": "array",
"items": {}
}
}
}
}
}
TagsGetSpecificTagResponse
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": [
"string",
"null"
]
},
"username": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
}
}
},
"topic_list": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"staff": {
"type": "boolean"
},
"topic_count": {
"type": "integer"
}
}
}
},
"draft": {
"type": [
"string",
"null"
]
},
"topics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"slug": {
"type": "string"
},
"tags": {
"type": "array",
"items": {}
},
"liked": {
"type": "boolean"
},
"title": {
"type": "string"
},
"views": {
"type": "integer"
},
"bumped": {
"type": "boolean"
},
"closed": {
"type": "boolean"
},
"pinned": {
"type": "boolean"
},
"unseen": {
"type": "boolean"
},
"posters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"extras": {
"type": "string"
},
"user_id": {
"type": "integer"
},
"description": {
"type": "string"
},
"primary_group_id": {
"type": [
"string",
"null"
]
}
}
}
},
"visible": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"unpinned": {
"type": [
"string",
"null"
]
},
"archetype": {
"type": "string"
},
"bumped_at": {
"type": "string"
},
"image_url": {
"type": [
"string",
"null"
]
},
"bookmarked": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"like_count": {
"type": "integer"
},
"category_id": {
"type": "integer"
},
"fancy_title": {
"type": "string"
},
"has_summary": {
"type": "boolean"
},
"posts_count": {
"type": "integer"
},
"reply_count": {
"type": "integer"
},
"unread_posts": {
"type": "integer"
},
"featured_link": {
"type": [
"string",
"null"
]
},
"last_posted_at": {
"type": "string"
},
"pinned_globally": {
"type": "boolean"
},
"notification_level": {
"type": "integer"
},
"highest_post_number": {
"type": "integer"
},
"last_poster_username": {
"type": "string"
},
"last_read_post_number": {
"type": "integer"
}
}
}
},
"per_page": {
"type": "integer"
},
"draft_key": {
"type": "string"
},
"draft_sequence": {
"type": "integer"
},
"can_create_topic": {
"type": "boolean"
}
}
},
"primary_groups": {
"type": "array",
"items": {}
}
}
}
TagsGetTagGroupsResponse
{
"type": "object",
"properties": {
"tag_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"tag_names": {
"type": "array",
"items": {}
},
"permissions": {
"type": "object",
"properties": {
"staff": {
"type": "integer"
}
}
},
"one_per_topic": {
"type": "boolean"
},
"parent_tag_name": {
"type": "array",
"items": {}
}
}
}
}
}
}
TagsListResponse
{
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string"
},
"count": {
"type": "integer"
},
"pm_count": {
"type": "integer"
},
"target_tag": {
"type": [
"string",
"null"
]
}
}
}
},
"extras": {
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {}
}
}
}
}
}
TagsUpdateTagGroupRequest
{
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
TagsUpdateTagGroupResponse
{
"type": "object",
"properties": {
"success": {
"type": "string"
},
"tag_group": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"tag_names": {
"type": "array",
"items": {}
},
"permissions": {
"type": "object",
"properties": {
"everyone": {
"type": "integer"
}
}
},
"one_per_topic": {
"type": "boolean"
},
"parent_tag_name": {
"type": "array",
"items": {}
}
}
}
}
}
TopicsCreateTopicTimerRequest
{
"type": "object",
"properties": {
"time": {
"type": "string",
"example": ""
},
"category_id": {
"type": "integer"
},
"status_type": {
"type": "string"
},
"based_on_last_post": {
"type": "boolean"
}
}
}
TopicsCreateTopicTimerResponse
{
"type": "object",
"properties": {
"closed": {
"type": "boolean"
},
"success": {
"type": "string",
"example": "OK"
},
"duration": {
"type": [
"string",
"null"
]
},
"execute_at": {
"type": "string"
},
"category_id": {
"type": [
"string",
"null"
]
},
"based_on_last_post": {
"type": "boolean"
}
}
}
TopicsGetLatestTopicsResponse
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": [
"string",
"null"
]
},
"username": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
}
}
},
"topic_list": {
"type": "object",
"properties": {
"draft": {
"type": [
"string",
"null"
]
},
"topics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"slug": {
"type": "string"
},
"liked": {
"type": "boolean"
},
"title": {
"type": "string"
},
"views": {
"type": "integer"
},
"bumped": {
"type": "boolean"
},
"closed": {
"type": "boolean"
},
"pinned": {
"type": "boolean"
},
"unseen": {
"type": "boolean"
},
"posters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"extras": {
"type": "string"
},
"user_id": {
"type": "integer"
},
"description": {
"type": "string"
},
"primary_group_id": {
"type": [
"string",
"null"
]
}
}
}
},
"visible": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"unpinned": {
"type": [
"string",
"null"
]
},
"archetype": {
"type": "string"
},
"bumped_at": {
"type": "string"
},
"image_url": {
"type": "string"
},
"bookmarked": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"like_count": {
"type": "integer"
},
"category_id": {
"type": "integer"
},
"fancy_title": {
"type": "string"
},
"has_summary": {
"type": "boolean"
},
"posts_count": {
"type": "integer"
},
"reply_count": {
"type": "integer"
},
"unread_posts": {
"type": "integer"
},
"featured_link": {
"type": [
"string",
"null"
]
},
"op_like_count": {
"type": "integer"
},
"last_posted_at": {
"type": "string"
},
"pinned_globally": {
"type": "boolean"
},
"notification_level": {
"type": "integer"
},
"highest_post_number": {
"type": "integer"
},
"last_poster_username": {
"type": "string"
},
"last_read_post_number": {
"type": "integer"
}
}
}
},
"per_page": {
"type": "integer"
},
"draft_key": {
"type": "string"
},
"draft_sequence": {
"type": "integer"
},
"can_create_topic": {
"type": "boolean"
}
}
},
"primary_groups": {
"type": "array",
"items": {}
}
}
}
TopicsGetSingleTopicResponse
{
"required": [
"post_stream",
"timeline_lookup",
"suggested_topics",
"tags",
"tags_descriptions",
"id",
"title",
"fancy_title",
"posts_count",
"created_at",
"views",
"reply_count",
"like_count",
"last_posted_at",
"visible",
"closed",
"archived",
"has_summary",
"archetype",
"slug",
"category_id",
"word_count",
"deleted_at",
"user_id",
"featured_link",
"pinned_globally",
"pinned_at",
"pinned_until",
"image_url",
"slow_mode_seconds",
"draft",
"draft_key",
"draft_sequence",
"unpinned",
"pinned",
"highest_post_number",
"deleted_by",
"has_deleted",
"actions_summary",
"chunk_size",
"bookmarked",
"bookmarks",
"topic_timer",
"message_bus_last_id",
"participant_count",
"show_read_indicator",
"thumbnails",
"slow_mode_enabled_until",
"summarizable",
"details"
],
"properties": {
"id": {
"type": "integer"
},
"slug": {
"type": "string"
},
"tags": {
"type": "array",
"items": {}
},
"draft": {
"type": [
"string",
"null"
]
},
"title": {
"type": "string"
},
"views": {
"type": "integer"
},
"closed": {
"type": "boolean"
},
"pinned": {
"type": "boolean"
},
"details": {
"type": "object",
"required": [
"can_edit",
"notification_level",
"can_move_posts",
"can_delete",
"can_remove_allowed_users",
"can_create_post",
"can_reply_as_new_topic",
"can_convert_topic",
"can_review_topic",
"can_close_topic",
"can_archive_topic",
"can_split_merge_topic",
"can_edit_staff_notes",
"can_toggle_topic_visibility",
"can_pin_unpin_topic",
"can_moderate_category",
"can_remove_self_id",
"created_by",
"last_poster"
],
"properties": {
"can_edit": {
"type": "boolean"
},
"can_delete": {
"type": "boolean"
},
"created_by": {
"type": "object",
"required": [
"id",
"username",
"name",
"avatar_template"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"username": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
}
},
"last_poster": {
"type": "object",
"required": [
"id",
"username",
"name",
"avatar_template"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"username": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
}
},
"participants": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"username",
"name",
"avatar_template",
"post_count",
"primary_group_name",
"flair_name",
"flair_url",
"flair_color",
"flair_bg_color",
"admin",
"moderator",
"trust_level"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"admin": {
"type": "boolean"
},
"username": {
"type": "string"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"moderator": {
"type": "boolean"
},
"flair_name": {
"type": [
"string",
"null"
]
},
"post_count": {
"type": "integer"
},
"flair_color": {
"type": [
"string",
"null"
]
},
"trust_level": {
"type": "integer"
},
"flair_bg_color": {
"type": [
"string",
"null"
]
},
"flair_group_id": {
"type": [
"string",
"null"
]
},
"avatar_template": {
"type": "string"
},
"primary_group_name": {
"type": [
"string",
"null"
]
}
}
}
},
"can_invite_to": {
"type": "boolean"
},
"can_flag_topic": {
"type": "boolean"
},
"can_move_posts": {
"type": "boolean"
},
"can_close_topic": {
"type": "boolean"
},
"can_create_post": {
"type": "boolean"
},
"can_review_topic": {
"type": "boolean"
},
"can_archive_topic": {
"type": "boolean"
},
"can_convert_topic": {
"type": "boolean"
},
"can_remove_self_id": {
"type": "integer"
},
"notification_level": {
"type": "integer"
},
"can_pin_unpin_topic": {
"type": "boolean"
},
"can_edit_staff_notes": {
"type": "boolean"
},
"can_invite_via_email": {
"type": "boolean"
},
"can_moderate_category": {
"type": "boolean"
},
"can_split_merge_topic": {
"type": "boolean"
},
"can_reply_as_new_topic": {
"type": "boolean"
},
"can_remove_allowed_users": {
"type": "boolean"
},
"can_toggle_topic_visibility": {
"type": "boolean"
}
}
},
"user_id": {
"type": "integer"
},
"visible": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"unpinned": {
"type": [
"string",
"null"
]
},
"archetype": {
"type": "string"
},
"bookmarks": {
"type": "array",
"items": {}
},
"draft_key": {
"type": "string"
},
"image_url": {
"type": [
"string",
"null"
]
},
"pinned_at": {
"type": [
"string",
"null"
]
},
"bookmarked": {
"type": "boolean"
},
"chunk_size": {
"type": "integer"
},
"created_at": {
"type": "string"
},
"deleted_at": {
"type": [
"string",
"null"
]
},
"deleted_by": {
"type": [
"string",
"null"
]
},
"like_count": {
"type": "integer"
},
"thumbnails": {
"type": [
"string",
"null"
]
},
"word_count": {
"type": [
"integer",
"null"
]
},
"category_id": {
"type": "integer"
},
"fancy_title": {
"type": "string"
},
"has_deleted": {
"type": "boolean"
},
"has_summary": {
"type": "boolean"
},
"post_stream": {
"type": "object",
"required": [
"posts",
"stream"
],
"properties": {
"posts": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"username",
"avatar_template",
"created_at",
"cooked",
"post_number",
"post_type",
"updated_at",
"reply_count",
"reply_to_post_number",
"quote_count",
"incoming_link_count",
"reads",
"readers_count",
"score",
"yours",
"topic_id",
"topic_slug",
"display_username",
"primary_group_name",
"flair_name",
"flair_url",
"flair_bg_color",
"flair_color",
"version",
"can_edit",
"can_delete",
"can_recover",
"can_wiki",
"link_counts",
"read",
"user_title",
"bookmarked",
"actions_summary",
"moderator",
"admin",
"staff",
"user_id",
"hidden",
"trust_level",
"deleted_at",
"user_deleted",
"edit_reason",
"can_view_edit_history",
"wiki",
"reviewable_id",
"reviewable_score_count",
"reviewable_score_pending_count"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"read": {
"type": "boolean"
},
"wiki": {
"type": "boolean"
},
"admin": {
"type": "boolean"
},
"reads": {
"type": "integer"
},
"score": {
"type": "number"
},
"staff": {
"type": "boolean"
},
"yours": {
"type": "boolean"
},
"cooked": {
"type": "string"
},
"hidden": {
"type": "boolean"
},
"user_id": {
"type": "integer"
},
"version": {
"type": "integer"
},
"can_edit": {
"type": "boolean"
},
"can_wiki": {
"type": "boolean"
},
"topic_id": {
"type": "integer"
},
"username": {
"type": "string"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"moderator": {
"type": "boolean"
},
"post_type": {
"type": "integer"
},
"bookmarked": {
"type": "boolean"
},
"can_delete": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"deleted_at": {
"type": [
"string",
"null"
]
},
"flair_name": {
"type": [
"string",
"null"
]
},
"topic_slug": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user_title": {
"type": [
"string",
"null"
]
},
"can_recover": {
"type": "boolean"
},
"edit_reason": {
"type": [
"string",
"null"
]
},
"flair_color": {
"type": [
"string",
"null"
]
},
"link_counts": {
"type": "array",
"items": {
"type": "object",
"required": [
"url",
"internal",
"reflection",
"title",
"clicks"
],
"properties": {
"url": {
"type": "string"
},
"title": {
"type": "string"
},
"clicks": {
"type": "integer"
},
"internal": {
"type": "boolean"
},
"reflection": {
"type": "boolean"
}
}
}
},
"post_number": {
"type": "integer"
},
"quote_count": {
"type": "integer"
},
"reply_count": {
"type": "integer"
},
"trust_level": {
"type": "integer"
},
"user_deleted": {
"type": "boolean"
},
"readers_count": {
"type": "integer"
},
"reviewable_id": {
"type": "integer"
},
"flair_bg_color": {
"type": [
"string",
"null"
]
},
"actions_summary": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"can_act"
],
"properties": {
"id": {
"type": "integer"
},
"can_act": {
"type": "boolean"
}
}
}
},
"avatar_template": {
"type": "string"
},
"display_username": {
"type": "string"
},
"primary_group_name": {
"type": [
"string",
"null"
]
},
"can_see_hidden_post": {
"type": "boolean"
},
"incoming_link_count": {
"type": "integer"
},
"reply_to_post_number": {
"type": [
"string",
"null"
]
},
"can_view_edit_history": {
"type": "boolean"
},
"reviewable_score_count": {
"type": "integer"
},
"reviewable_score_pending_count": {
"type": "integer"
}
}
}
},
"stream": {
"type": "array",
"items": {}
}
}
},
"posts_count": {
"type": "integer"
},
"reply_count": {
"type": "integer"
},
"topic_timer": {
"type": [
"string",
"null"
]
},
"pinned_until": {
"type": [
"string",
"null"
]
},
"summarizable": {
"type": "boolean"
},
"featured_link": {
"type": [
"string",
"null"
]
},
"draft_sequence": {
"type": "integer"
},
"last_posted_at": {
"type": [
"string",
"null"
]
},
"actions_summary": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"count",
"hidden",
"can_act"
],
"properties": {
"id": {
"type": "integer"
},
"count": {
"type": "integer"
},
"hidden": {
"type": "boolean"
},
"can_act": {
"type": "boolean"
}
}
}
},
"pinned_globally": {
"type": "boolean"
},
"timeline_lookup": {
"type": "array",
"items": {}
},
"suggested_topics": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"title",
"fancy_title",
"slug",
"posts_count",
"reply_count",
"highest_post_number",
"image_url",
"created_at",
"last_posted_at",
"bumped",
"bumped_at",
"archetype",
"unseen",
"pinned",
"unpinned",
"excerpt",
"visible",
"closed",
"archived",
"bookmarked",
"liked",
"tags",
"tags_descriptions",
"like_count",
"views",
"category_id",
"featured_link",
"posters"
],
"properties": {
"id": {
"type": "integer"
},
"slug": {
"type": "string"
},
"tags": {
"type": "array",
"items": {}
},
"liked": {
"type": [
"string",
"null"
]
},
"title": {
"type": "string"
},
"views": {
"type": "integer"
},
"bumped": {
"type": "boolean"
},
"closed": {
"type": "boolean"
},
"pinned": {
"type": "boolean"
},
"unseen": {
"type": "boolean"
},
"excerpt": {
"type": "string"
},
"posters": {
"type": "array",
"items": {
"type": "object",
"required": [
"extras",
"description",
"user"
],
"properties": {
"user": {
"type": "object",
"required": [
"id",
"username",
"name",
"avatar_template"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"username": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
}
},
"extras": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
},
"visible": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"unpinned": {
"type": [
"string",
"null"
]
},
"archetype": {
"type": "string"
},
"bumped_at": {
"type": "string"
},
"image_url": {
"type": [
"string",
"null"
]
},
"bookmarked": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string"
},
"like_count": {
"type": "integer"
},
"category_id": {
"type": "integer"
},
"fancy_title": {
"type": "string"
},
"posts_count": {
"type": "integer"
},
"reply_count": {
"type": "integer"
},
"featured_link": {
"type": [
"string",
"null"
]
},
"last_posted_at": {
"type": [
"string",
"null"
]
},
"tags_descriptions": {
"type": "object",
"properties": {}
},
"highest_post_number": {
"type": "integer"
}
}
}
},
"participant_count": {
"type": "integer"
},
"slow_mode_seconds": {
"type": "integer"
},
"tags_descriptions": {
"type": "object",
"properties": {}
},
"current_post_number": {
"type": "integer"
},
"highest_post_number": {
"type": [
"integer",
"null"
]
},
"message_bus_last_id": {
"type": "integer"
},
"show_read_indicator": {
"type": "boolean"
},
"slow_mode_enabled_until": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}
TopicsGetSpecificPostsRequest
{
"type": "object",
"required": [
"post_ids[]"
],
"properties": {
"post_ids[]": {
"type": "integer"
}
}
}
TopicsGetSpecificPostsResponse
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"post_stream": {
"type": "object",
"properties": {
"posts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": [
"string",
"null"
]
},
"read": {
"type": "boolean"
},
"wiki": {
"type": "boolean"
},
"admin": {
"type": "boolean"
},
"reads": {
"type": "integer"
},
"score": {
"type": "number"
},
"staff": {
"type": "boolean"
},
"yours": {
"type": "boolean"
},
"cooked": {
"type": "string"
},
"hidden": {
"type": "boolean"
},
"user_id": {
"type": "integer"
},
"version": {
"type": "integer"
},
"can_edit": {
"type": "boolean"
},
"can_wiki": {
"type": "boolean"
},
"topic_id": {
"type": "integer"
},
"username": {
"type": "string"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"moderator": {
"type": "boolean"
},
"post_type": {
"type": "integer"
},
"can_delete": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"deleted_at": {
"type": [
"string",
"null"
]
},
"flair_name": {
"type": [
"string",
"null"
]
},
"topic_slug": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user_title": {
"type": [
"string",
"null"
]
},
"can_recover": {
"type": "boolean"
},
"edit_reason": {
"type": [
"string",
"null"
]
},
"flair_color": {
"type": [
"string",
"null"
]
},
"post_number": {
"type": "integer"
},
"quote_count": {
"type": "integer"
},
"reply_count": {
"type": "integer"
},
"trust_level": {
"type": "integer"
},
"user_deleted": {
"type": "boolean"
},
"readers_count": {
"type": "integer"
},
"reviewable_id": {
"type": "integer"
},
"flair_bg_color": {
"type": [
"string",
"null"
]
},
"actions_summary": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"can_act": {
"type": "boolean"
}
}
}
},
"avatar_template": {
"type": "string"
},
"display_username": {
"type": [
"string",
"null"
]
},
"primary_group_name": {
"type": [
"string",
"null"
]
},
"incoming_link_count": {
"type": "integer"
},
"reply_to_post_number": {
"type": [
"string",
"null"
]
},
"can_view_edit_history": {
"type": "boolean"
},
"reviewable_score_count": {
"type": "integer"
},
"reviewable_score_pending_count": {
"type": "integer"
}
}
}
}
}
}
}
}
TopicsGetTopTopicsByPeriodResponse
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"username": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
}
}
},
"topic_list": {
"type": "object",
"properties": {
"draft": {
"type": [
"string",
"null"
]
},
"topics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"slug": {
"type": "string"
},
"liked": {
"type": "boolean"
},
"title": {
"type": "string"
},
"views": {
"type": "integer"
},
"bumped": {
"type": "boolean"
},
"closed": {
"type": "boolean"
},
"pinned": {
"type": "boolean"
},
"unseen": {
"type": "boolean"
},
"posters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"extras": {
"type": [
"string",
"null"
]
},
"user_id": {
"type": "integer"
},
"description": {
"type": "string"
},
"primary_group_id": {
"type": [
"string",
"null"
]
}
}
}
},
"visible": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"unpinned": {
"type": "boolean"
},
"archetype": {
"type": "string"
},
"bumped_at": {
"type": "string"
},
"image_url": {
"type": [
"string",
"null"
]
},
"bookmarked": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"like_count": {
"type": "integer"
},
"category_id": {
"type": "integer"
},
"fancy_title": {
"type": "string"
},
"has_summary": {
"type": "boolean"
},
"posts_count": {
"type": "integer"
},
"reply_count": {
"type": "integer"
},
"unread_posts": {
"type": "integer"
},
"featured_link": {
"type": [
"string",
"null"
]
},
"op_like_count": {
"type": "integer"
},
"last_posted_at": {
"type": "string"
},
"pinned_globally": {
"type": "boolean"
},
"notification_level": {
"type": "integer"
},
"highest_post_number": {
"type": "integer"
},
"last_poster_username": {
"type": "string"
},
"last_read_post_number": {
"type": "integer"
}
}
}
},
"per_page": {
"type": "integer"
},
"draft_key": {
"type": "string"
},
"for_period": {
"type": "string"
},
"draft_sequence": {
"type": "integer"
},
"can_create_topic": {
"type": "boolean"
}
}
},
"primary_groups": {
"type": "array",
"items": {}
}
}
}
TopicsSendInviteToTopicRequest
{
"type": "object",
"properties": {
"user": {
"type": "string"
},
"email": {
"type": "string"
}
}
}
TopicsSendInviteToTopicResponse
{
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"username": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
}
}
}
}
TopicsSetNotificationLevelRequest
{
"type": "object",
"required": [
"notification_level"
],
"properties": {
"notification_level": {
"enum": [
"0",
"1",
"2",
"3"
],
"type": "string"
}
}
}
TopicsSetNotificationLevelResponse
{
"type": "object",
"properties": {
"success": {
"type": "string",
"example": "OK"
}
}
}
TopicsUpdateStatusOfTopicRequest
{
"type": "object",
"required": [
"status",
"enabled"
],
"properties": {
"until": {
"type": "string",
"example": "2030-12-31",
"description": "Only required for `pinned` and `pinned_globally`"
},
"status": {
"enum": [
"closed",
"pinned",
"pinned_globally",
"archived",
"visible"
],
"type": "string"
},
"enabled": {
"enum": [
"true",
"false"
],
"type": "string"
}
}
}
TopicsUpdateStatusOfTopicResponse
{
"type": "object",
"properties": {
"success": {
"type": "string",
"example": "OK"
},
"topic_status_update": {
"type": [
"string",
"null"
]
}
}
}
TopicsUpdateTimestampJsonRequest
{
"type": "object",
"required": [
"timestamp"
],
"properties": {
"timestamp": {
"type": "string",
"example": "1594291380"
}
}
}
TopicsUpdateTimestampJsonResponse
{
"type": "object",
"properties": {
"success": {
"type": "string",
"example": "OK"
}
}
}
TopicsUpdateTopicByIdJsonRequest
{
"type": "object",
"properties": {
"topic": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"category_id": {
"type": "integer"
}
}
}
}
}
TopicsUpdateTopicByIdJsonResponse
{
"type": "object",
"properties": {
"basic_topic": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"slug": {
"type": "string"
},
"title": {
"type": "string"
},
"fancy_title": {
"type": "string"
},
"posts_count": {
"type": "integer"
}
}
}
}
}
UploadsAbortMultipartUploadRequest
{
"required": [
"external_upload_identifier"
],
"properties": {
"external_upload_identifier": {
"type": "string",
"example": "84x83tmxy398t3y._Q_z8CoJYVr69bE6D7f8J6Oo0434QquLFoYdGVerWFx9X5HDEI_TP_95c34n853495x35345394.d.ghQ",
"description": "The identifier of the multipart upload in the external\nstorage provider. This is the multipart upload_id in AWS S3."
}
},
"additionalProperties": false
}
UploadsAbortMultipartUploadResponse
{
"required": [
"success"
],
"properties": {
"success": {
"type": "string",
"example": "OK"
}
},
"additionalProperties": false
}
UploadsCompleteExternalUploadRequest
{
"required": [
"unique_identifier"
],
"properties": {
"pasted": {
"type": "string",
"example": "true",
"description": "Optionally set this to true if the upload was pasted\ninto the upload area. This will convert PNG files to JPEG."
},
"for_site_setting": {
"type": "string",
"example": "true",
"description": "Optionally set this to true if the upload is for a\nsite setting."
},
"unique_identifier": {
"type": "string",
"example": "66e86218-80d9-4bda-b4d5-2b6def968705",
"description": "The unique identifier returned in the original /generate-presigned-put\nrequest."
},
"for_private_message": {
"type": "string",
"example": "true",
"description": "Optionally set this to true if the upload is for a\nprivate message."
}
},
"additionalProperties": false
}
UploadsCompleteExternalUploadResponse
{
"required": [
"id",
"url",
"original_filename",
"filesize",
"width",
"height",
"thumbnail_width",
"thumbnail_height",
"extension",
"short_url",
"short_path",
"retain_hours",
"human_filesize"
],
"properties": {
"id": {
"type": "integer"
},
"url": {
"type": "string"
},
"width": {
"type": "integer"
},
"height": {
"type": "integer"
},
"filesize": {
"type": "integer"
},
"extension": {
"type": "string"
},
"short_url": {
"type": "string"
},
"short_path": {
"type": "string"
},
"retain_hours": {
"type": [
"string",
"null"
]
},
"dominant_color": {
"type": [
"string",
"null"
]
},
"human_filesize": {
"type": "string"
},
"thumbnail_width": {
"type": "integer"
},
"thumbnail_height": {
"type": "integer"
},
"original_filename": {
"type": "string"
}
},
"additionalProperties": false
}
UploadsCompleteMultipartUploadRequest
{
"required": [
"unique_identifier",
"parts"
],
"properties": {
"parts": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
},
"example": [
{
"etag": "0c376dcfcc2606f4335bbc732de93344",
"part_number": 1
},
{
"etag": "09ert8cfcc2606f4335bbc732de91122",
"part_number": 2
}
],
"description": "All of the part numbers and their corresponding ETags\nthat have been uploaded must be provided."
},
"unique_identifier": {
"type": "string",
"example": "66e86218-80d9-4bda-b4d5-2b6def968705",
"description": "The unique identifier returned in the original /create-multipart\nrequest."
}
},
"additionalProperties": false
}
UploadsCompleteMultipartUploadResponse
{
"required": [
"id",
"url",
"original_filename",
"filesize",
"width",
"height",
"thumbnail_width",
"thumbnail_height",
"extension",
"short_url",
"short_path",
"retain_hours",
"human_filesize"
],
"properties": {
"id": {
"type": "integer"
},
"url": {
"type": "string"
},
"width": {
"type": "integer"
},
"height": {
"type": "integer"
},
"filesize": {
"type": "integer"
},
"extension": {
"type": "string"
},
"short_url": {
"type": "string"
},
"short_path": {
"type": "string"
},
"retain_hours": {
"type": [
"string",
"null"
]
},
"dominant_color": {
"type": [
"string",
"null"
]
},
"human_filesize": {
"type": "string"
},
"thumbnail_width": {
"type": "integer"
},
"thumbnail_height": {
"type": "integer"
},
"original_filename": {
"type": "string"
}
},
"additionalProperties": false
}
UploadsCreateMultipartExternalUploadRequest
{
"required": [
"upload_type",
"file_name",
"file_size"
],
"properties": {
"metadata": {
"type": "object",
"properties": {
"sha1-checksum": {
"type": "string",
"description": "The SHA1 checksum of the upload binary blob. Optionally\nbe provided and serves as an additional security check when\nlater processing the file in complete-external-upload endpoint."
}
}
},
"file_name": {
"type": "string",
"example": "IMG_2021.jpeg"
},
"file_size": {
"type": "integer",
"example": 4096,
"description": "File size should be represented in bytes."
},
"upload_type": {
"enum": [
"avatar",
"profile_background",
"card_background",
"custom_emoji",
"composer"
],
"type": "string"
}
},
"additionalProperties": false
}
UploadsCreateMultipartExternalUploadResponse
{
"required": [
"external_upload_identifier",
"key",
"unique_identifier"
],
"properties": {
"key": {
"type": "string",
"example": "temp/site/uploads/default/12345/67890.jpg",
"description": "The path of the temporary file on the external storage\nservice."
},
"unique_identifier": {
"type": "string",
"example": "66e86218-80d9-4bda-b4d5-2b6def968705",
"description": "A unique string that identifies the external upload.\nThis must be stored and then sent in the /complete-multipart\nand /batch-presign-multipart-parts endpoints."
},
"external_upload_identifier": {
"type": "string",
"example": "84x83tmxy398t3y._Q_z8CoJYVr69bE6D7f8J6Oo0434QquLFoYdGVerWFx9X5HDEI_TP_95c34n853495x35345394.d.ghQ",
"description": "The identifier of the multipart upload in the external\nstorage provider. This is the multipart upload_id in AWS S3."
}
},
"additionalProperties": false
}
UploadsCreateNewUploadRequest
{
"required": [
"type"
],
"properties": {
"file": {
"type": "string",
"format": "binary"
},
"type": {
"enum": [
"avatar",
"profile_background",
"card_background",
"custom_emoji",
"composer"
],
"type": "string"
},
"user_id": {
"type": "integer",
"description": "required if uploading an avatar"
},
"synchronous": {
"type": "boolean",
"description": "Use this flag to return an id and url"
}
},
"additionalProperties": false
}
UploadsCreateNewUploadResponse
{
"required": [
"id",
"url",
"original_filename",
"filesize",
"width",
"height",
"thumbnail_width",
"thumbnail_height",
"extension",
"short_url",
"short_path",
"retain_hours",
"human_filesize"
],
"properties": {
"id": {
"type": "integer"
},
"url": {
"type": "string"
},
"width": {
"type": "integer"
},
"height": {
"type": "integer"
},
"filesize": {
"type": "integer"
},
"extension": {
"type": "string"
},
"short_url": {
"type": "string"
},
"short_path": {
"type": "string"
},
"retain_hours": {
"type": [
"string",
"null"
]
},
"dominant_color": {
"type": [
"string",
"null"
]
},
"human_filesize": {
"type": "string"
},
"thumbnail_width": {
"type": "integer"
},
"thumbnail_height": {
"type": "integer"
},
"original_filename": {
"type": "string"
}
},
"additionalProperties": false
}
UploadsGeneratePresignedUrlsForMultipartPartsRequest
{
"required": [
"part_numbers",
"unique_identifier"
],
"properties": {
"part_numbers": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
},
"example": [
1,
2,
3
],
"description": "The part numbers to generate the presigned URLs for,\nmust be between 1 and 10000."
},
"unique_identifier": {
"type": "string",
"example": "66e86218-80d9-4bda-b4d5-2b6def968705",
"description": "The unique identifier returned in the original /create-multipart\nrequest."
}
},
"additionalProperties": false
}
UploadsGeneratePresignedUrlsForMultipartPartsResponse
{
"required": [
"presigned_urls"
],
"properties": {
"presigned_urls": {
"type": "object",
"example": {
"1": "https://discourse-martin-uploads-test.s3.us-east-2.amazonaws.com/temp/uploads/default/123abc/123abc.jpg?partNumber=1&uploadId=123456abcd&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=test&X-Amz-Date=20211222T012336Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=abc123"
},
"description": "The presigned URLs for each part number, which has\nthe part numbers as keys."
}
},
"additionalProperties": false
}
UploadsInitiateDirectExternalUploadRequest
{
"required": [
"type",
"file_name",
"file_size"
],
"properties": {
"type": {
"enum": [
"avatar",
"profile_background",
"card_background",
"custom_emoji",
"composer"
],
"type": "string"
},
"metadata": {
"type": "object",
"properties": {
"sha1-checksum": {
"type": "string",
"description": "The SHA1 checksum of the upload binary blob. Optionally\nbe provided and serves as an additional security check when\nlater processing the file in complete-external-upload endpoint."
}
}
},
"file_name": {
"type": "string",
"example": "IMG_2021.jpeg"
},
"file_size": {
"type": "integer",
"example": 4096,
"description": "File size should be represented in bytes."
}
},
"additionalProperties": false
}
UploadsInitiateDirectExternalUploadResponse
{
"properties": {
"key": {
"type": "string",
"example": "temp/site/uploads/default/12345/67890.jpg",
"description": "The path of the temporary file on the external storage\nservice."
},
"url": {
"type": "string",
"example": "https://file-uploads.s3.us-west-2.amazonaws.com/temp/site/uploads/default/123/456.jpg?x-amz-acl=private&x-amz-meta-sha1-checksum=sha1&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AAAAus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20211221T011246Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=12345678",
"description": "A presigned PUT URL which must be used to upload\nthe file binary blob to."
},
"signed_headers": {
"type": "object",
"example": {
"x-amz-acl": "private",
"x-amz-meta-sha1-checksum": "sha1"
},
"description": "A map of headers that must be sent with the PUT request."
},
"unique_identifier": {
"type": "string",
"example": "66e86218-80d9-4bda-b4d5-2b6def968705",
"description": "A unique string that identifies the external upload.\nThis must be stored and then sent in the /complete-external-upload\nendpoint to complete the direct upload."
}
},
"additionalProperties": false
}
UsersActivateUserResponse
{
"required": [
"success"
],
"properties": {
"success": {
"type": "string",
"example": "OK"
}
},
"additionalProperties": false
}
UsersAnonymizeByIdJsonResponse
{
"required": [
"success",
"username"
],
"properties": {
"success": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
}
UsersChangePasswordActionRequest
{
"required": [
"username",
"password"
],
"properties": {
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
}
UsersCreateUserRequest
{
"required": [
"name",
"email",
"password",
"username"
],
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"active": {
"type": "boolean",
"description": "This param requires an api key in the request header\nor it will be ignored"
},
"approved": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
},
"external_ids": {
"type": "object"
},
"user_fields[1]": {
"type": "boolean"
}
},
"additionalProperties": false
}
UsersCreateUserResponse
{
"required": [
"success",
"active",
"message"
],
"properties": {
"active": {
"type": "boolean"
},
"message": {
"type": "string"
},
"success": {
"type": "boolean"
},
"user_id": {
"type": "integer"
}
},
"additionalProperties": false
}
UsersDeactivateUserResponse
{
"required": [
"success"
],
"properties": {
"success": {
"type": "string",
"example": "OK"
}
},
"additionalProperties": false
}
UsersDeleteUserByIdJsonRequest
{
"properties": {
"block_ip": {
"type": "boolean"
},
"block_urls": {
"type": "boolean"
},
"block_email": {
"type": "boolean"
},
"delete_posts": {
"type": "boolean"
}
},
"additionalProperties": false
}
UsersDeleteUserByIdJsonResponse
{
"required": [
"deleted"
],
"properties": {
"deleted": {
"type": "boolean"
}
},
"additionalProperties": false
}
UsersGetEmailsResponse
{
"required": [
"email",
"secondary_emails",
"unconfirmed_emails",
"associated_accounts"
],
"properties": {
"email": {
"type": "string"
},
"secondary_emails": {
"type": "array",
"items": {}
},
"unconfirmed_emails": {
"type": "array",
"items": {}
},
"associated_accounts": {
"type": "array",
"items": {}
}
},
"additionalProperties": false
}
UsersGetIdentityProviderExternalIdResponse
{
"required": [
"user_badges",
"user"
],
"properties": {
"user": {
"type": "object",
"required": [
"id",
"username",
"name",
"avatar_template",
"last_posted_at",
"last_seen_at",
"created_at",
"ignored",
"muted",
"can_ignore_user",
"can_mute_user",
"can_send_private_messages",
"can_send_private_message_to_user",
"trust_level",
"moderator",
"admin",
"title",
"badge_count",
"custom_fields",
"time_read",
"recent_time_read",
"primary_group_id",
"primary_group_name",
"flair_group_id",
"flair_name",
"flair_url",
"flair_bg_color",
"flair_color",
"featured_topic",
"staged",
"can_edit",
"can_edit_username",
"can_edit_email",
"can_edit_name",
"uploaded_avatar_id",
"has_title_badges",
"pending_count",
"profile_view_count",
"second_factor_enabled",
"can_upload_profile_header",
"can_upload_user_card_background",
"post_count",
"can_be_deleted",
"can_delete_all_posts",
"locale",
"muted_category_ids",
"regular_category_ids",
"watched_tags",
"watching_first_post_tags",
"tracked_tags",
"muted_tags",
"tracked_category_ids",
"watched_category_ids",
"watched_first_post_category_ids",
"system_avatar_upload_id",
"system_avatar_template",
"muted_usernames",
"ignored_usernames",
"allowed_pm_usernames",
"mailing_list_posts_per_day",
"can_change_bio",
"can_change_location",
"can_change_website",
"can_change_tracking_preferences",
"user_api_keys",
"user_auth_tokens",
"user_notification_schedule",
"use_logo_small_as_avatar",
"featured_user_badge_ids",
"invited_by",
"groups",
"group_users",
"user_option"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"admin": {
"type": "boolean"
},
"muted": {
"type": "boolean"
},
"title": {
"type": [
"string",
"null"
]
},
"groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"automatic",
"name",
"display_name",
"user_count",
"mentionable_level",
"messageable_level",
"visibility_level",
"primary_group",
"title",
"grant_trust_level",
"incoming_email",
"has_messages",
"flair_url",
"flair_bg_color",
"flair_color",
"bio_raw",
"bio_cooked",
"bio_excerpt",
"public_admission",
"public_exit",
"allow_membership_requests",
"full_name",
"default_notification_level",
"membership_request_template",
"members_visibility_level",
"can_see_members",
"can_admin_group",
"publish_read_state"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"title": {
"type": [
"string",
"null"
]
},
"bio_raw": {
"type": [
"string",
"null"
]
},
"automatic": {
"type": "boolean"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"full_name": {
"type": [
"string",
"null"
]
},
"bio_cooked": {
"type": [
"string",
"null"
]
},
"user_count": {
"type": "integer"
},
"bio_excerpt": {
"type": [
"string",
"null"
]
},
"flair_color": {
"type": [
"string",
"null"
]
},
"public_exit": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"has_messages": {
"type": "boolean"
},
"primary_group": {
"type": "boolean"
},
"flair_bg_color": {
"type": [
"string",
"null"
]
},
"incoming_email": {
"type": [
"string",
"null"
]
},
"can_admin_group": {
"type": "boolean"
},
"can_see_members": {
"type": "boolean"
},
"public_admission": {
"type": "boolean"
},
"visibility_level": {
"type": "integer"
},
"grant_trust_level": {
"type": [
"string",
"null"
]
},
"mentionable_level": {
"type": "integer"
},
"messageable_level": {
"type": "integer"
},
"publish_read_state": {
"type": "boolean"
},
"members_visibility_level": {
"type": "integer"
},
"allow_membership_requests": {
"type": "boolean"
},
"default_notification_level": {
"type": "integer"
},
"membership_request_template": {
"type": [
"string",
"null"
]
}
}
}
},
"locale": {
"type": [
"string",
"null"
]
},
"staged": {
"type": "boolean"
},
"ignored": {
"type": "boolean"
},
"can_edit": {
"type": "boolean"
},
"username": {
"type": "string"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"moderator": {
"type": "boolean"
},
"time_read": {
"type": "integer"
},
"created_at": {
"type": "string"
},
"flair_name": {
"type": [
"string",
"null"
]
},
"invited_by": {
"type": [
"string",
"null"
]
},
"muted_tags": {
"type": "array",
"items": {}
},
"post_count": {
"type": "integer"
},
"badge_count": {
"type": "integer"
},
"flair_color": {
"type": [
"string",
"null"
]
},
"group_users": {
"type": "array",
"items": {
"type": "object",
"required": [
"group_id",
"user_id",
"notification_level"
],
"properties": {
"owner": {
"type": "boolean"
},
"user_id": {
"type": "integer"
},
"group_id": {
"type": "integer"
},
"notification_level": {
"type": "integer"
}
}
}
},
"trust_level": {
"type": "integer"
},
"user_fields": {
"type": "object",
"required": [
"1",
"2"
],
"properties": {
"1": {
"type": [
"string",
"null"
]
},
"2": {
"type": [
"string",
"null"
]
}
}
},
"user_option": {
"type": "object",
"required": [
"user_id",
"mailing_list_mode",
"mailing_list_mode_frequency",
"email_digests",
"email_level",
"email_messages_level",
"external_links_in_new_tab",
"color_scheme_id",
"dark_scheme_id",
"dynamic_favicon",
"enable_quoting",
"enable_defer",
"digest_after_minutes",
"automatically_unpin_topics",
"auto_track_topics_after_msecs",
"notification_level_when_replying",
"new_topic_duration_minutes",
"email_previous_replies",
"email_in_reply_to",
"like_notification_frequency",
"include_tl0_in_digests",
"theme_ids",
"theme_key_seq",
"allow_private_messages",
"enable_allowed_pm_users",
"homepage_id",
"hide_profile_and_presence",
"text_size",
"text_size_seq",
"title_count_mode",
"timezone",
"skip_new_user_tips",
"topics_unread_when_closed"
],
"properties": {
"user_id": {
"type": "integer"
},
"timezone": {
"type": [
"string",
"null"
]
},
"text_size": {
"type": "string"
},
"theme_ids": {
"type": "array",
"items": {}
},
"email_level": {
"type": "integer"
},
"homepage_id": {
"type": [
"string",
"null"
]
},
"seen_popups": {
"type": [
"array",
"null"
]
},
"enable_defer": {
"type": "boolean"
},
"email_digests": {
"type": "boolean"
},
"text_size_seq": {
"type": "integer"
},
"theme_key_seq": {
"type": "integer"
},
"dark_scheme_id": {
"type": [
"string",
"null"
]
},
"enable_quoting": {
"type": "boolean"
},
"color_scheme_id": {
"type": [
"string",
"null"
]
},
"dynamic_favicon": {
"type": "boolean"
},
"default_calendar": {
"type": "string"
},
"title_count_mode": {
"type": "string"
},
"email_in_reply_to": {
"type": "boolean"
},
"mailing_list_mode": {
"type": "boolean"
},
"skip_new_user_tips": {
"type": "boolean"
},
"digest_after_minutes": {
"type": "integer"
},
"email_messages_level": {
"type": "integer"
},
"allow_private_messages": {
"type": "boolean"
},
"email_previous_replies": {
"type": "integer"
},
"include_tl0_in_digests": {
"type": "boolean"
},
"oldest_search_log_date": {
"type": [
"string",
"null"
]
},
"enable_allowed_pm_users": {
"type": "boolean"
},
"external_links_in_new_tab": {
"type": "boolean"
},
"hide_profile_and_presence": {
"type": "boolean"
},
"topics_unread_when_closed": {
"type": "boolean"
},
"automatically_unpin_topics": {
"type": "boolean"
},
"new_topic_duration_minutes": {
"type": "integer"
},
"like_notification_frequency": {
"type": "integer"
},
"mailing_list_mode_frequency": {
"type": "integer"
},
"auto_track_topics_after_msecs": {
"type": "integer"
},
"sidebar_link_to_filtered_list": {
"type": "boolean"
},
"watched_precedence_over_muted": {
"type": [
"boolean",
"null"
]
},
"bookmark_auto_delete_preference": {
"type": "integer"
},
"sidebar_show_count_of_new_items": {
"type": "boolean"
},
"notification_level_when_replying": {
"type": "integer"
}
}
},
"last_seen_at": {
"type": [
"string",
"null"
]
},
"sidebar_tags": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
}
},
"tracked_tags": {
"type": "array",
"items": {}
},
"watched_tags": {
"type": "array",
"items": {}
},
"can_edit_name": {
"type": "boolean"
},
"can_mute_user": {
"type": "boolean"
},
"custom_fields": {
"type": "object",
"properties": {
"first_name": {
"type": [
"string",
"null"
]
}
}
},
"pending_count": {
"type": "integer"
},
"user_api_keys": {
"type": [
"string",
"null"
]
},
"user_passkeys": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
}
},
"can_be_deleted": {
"type": "boolean"
},
"can_change_bio": {
"type": "boolean"
},
"can_edit_email": {
"type": "boolean"
},
"featured_topic": {
"type": [
"string",
"null"
]
},
"flair_bg_color": {
"type": [
"string",
"null"
]
},
"flair_group_id": {
"type": [
"string",
"null"
]
},
"last_posted_at": {
"type": [
"string",
"null"
]
},
"avatar_template": {
"type": "string"
},
"can_ignore_user": {
"type": "boolean"
},
"muted_usernames": {
"type": "array",
"items": {}
},
"has_title_badges": {
"type": "boolean"
},
"primary_group_id": {
"type": [
"string",
"null"
]
},
"recent_time_read": {
"type": "integer"
},
"user_auth_tokens": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"client_ip",
"location",
"browser",
"device",
"os",
"icon",
"created_at",
"seen_at",
"is_active"
],
"properties": {
"id": {
"type": "integer"
},
"os": {
"type": "string"
},
"icon": {
"type": "string"
},
"device": {
"type": "string"
},
"browser": {
"type": "string"
},
"seen_at": {
"type": "string"
},
"location": {
"type": "string"
},
"client_ip": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"created_at": {
"type": "string"
}
}
}
},
"can_edit_username": {
"type": "boolean"
},
"ignored_usernames": {
"type": "array",
"items": {}
},
"can_change_website": {
"type": "boolean"
},
"muted_category_ids": {
"type": "array",
"items": {}
},
"primary_group_name": {
"type": [
"string",
"null"
]
},
"profile_view_count": {
"type": "integer"
},
"uploaded_avatar_id": {
"type": [
"string",
"null"
]
},
"can_change_location": {
"type": "boolean"
},
"pending_posts_count": {
"type": "integer"
},
"allowed_pm_usernames": {
"type": "array",
"items": {}
},
"can_delete_all_posts": {
"type": "boolean"
},
"display_sidebar_tags": {
"type": "boolean"
},
"regular_category_ids": {
"type": "array",
"items": {}
},
"sidebar_category_ids": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
}
},
"tracked_category_ids": {
"type": "array",
"items": {}
},
"watched_category_ids": {
"type": "array",
"items": {}
},
"second_factor_enabled": {
"type": "boolean"
},
"system_avatar_template": {
"type": "string"
},
"featured_user_badge_ids": {
"type": "array",
"items": {}
},
"system_avatar_upload_id": {
"type": [
"string",
"null"
]
},
"use_logo_small_as_avatar": {
"type": "boolean"
},
"watching_first_post_tags": {
"type": "array",
"items": {}
},
"can_send_private_messages": {
"type": "boolean"
},
"can_upload_profile_header": {
"type": "boolean"
},
"mailing_list_posts_per_day": {
"type": "integer"
},
"user_notification_schedule": {
"type": "object",
"required": [
"enabled",
"day_0_start_time",
"day_0_end_time",
"day_1_start_time",
"day_1_end_time",
"day_2_start_time",
"day_2_end_time",
"day_3_start_time",
"day_3_end_time",
"day_4_start_time",
"day_4_end_time",
"day_5_start_time",
"day_5_end_time",
"day_6_start_time",
"day_6_end_time"
],
"properties": {
"enabled": {
"type": "boolean"
},
"day_0_end_time": {
"type": "integer"
},
"day_1_end_time": {
"type": "integer"
},
"day_2_end_time": {
"type": "integer"
},
"day_3_end_time": {
"type": "integer"
},
"day_4_end_time": {
"type": "integer"
},
"day_5_end_time": {
"type": "integer"
},
"day_6_end_time": {
"type": "integer"
},
"day_0_start_time": {
"type": "integer"
},
"day_1_start_time": {
"type": "integer"
},
"day_2_start_time": {
"type": "integer"
},
"day_3_start_time": {
"type": "integer"
},
"day_4_start_time": {
"type": "integer"
},
"day_5_start_time": {
"type": "integer"
},
"day_6_start_time": {
"type": "integer"
}
}
},
"second_factor_backup_enabled": {
"type": "boolean"
},
"can_change_tracking_preferences": {
"type": "boolean"
},
"can_upload_user_card_background": {
"type": "boolean"
},
"watched_first_post_category_ids": {
"type": "array",
"items": {}
},
"can_send_private_message_to_user": {
"type": "boolean"
},
"can_pick_theme_with_custom_homepage": {
"type": "boolean"
}
}
},
"user_badges": {
"type": "array",
"items": {}
}
},
"additionalProperties": false
}
UsersGetListOfUsersResponse
{
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"username",
"name",
"avatar_template",
"active",
"admin",
"moderator",
"last_seen_at",
"last_emailed_at",
"created_at",
"last_seen_age",
"last_emailed_age",
"created_at_age",
"trust_level",
"manual_locked_trust_level",
"title",
"time_read",
"staged",
"days_visited",
"posts_read_count",
"topics_entered",
"post_count"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": [
"string",
"null"
]
},
"admin": {
"type": "boolean"
},
"email": {
"type": "string"
},
"title": {
"type": [
"string",
"null"
]
},
"active": {
"type": "boolean"
},
"staged": {
"type": "boolean"
},
"username": {
"type": "string"
},
"moderator": {
"type": "boolean"
},
"time_read": {
"type": "integer"
},
"created_at": {
"type": "string"
},
"post_count": {
"type": "integer"
},
"trust_level": {
"type": "integer"
},
"days_visited": {
"type": "integer"
},
"last_seen_at": {
"type": [
"string",
"null"
]
},
"last_seen_age": {
"type": [
"number",
"null"
]
},
"created_at_age": {
"type": [
"number",
"null"
]
},
"topics_entered": {
"type": "integer"
},
"avatar_template": {
"type": "string"
},
"last_emailed_at": {
"type": [
"string",
"null"
]
},
"last_emailed_age": {
"type": [
"number",
"null"
]
},
"posts_read_count": {
"type": "integer"
},
"secondary_emails": {
"type": "array",
"items": {}
},
"manual_locked_trust_level": {
"type": [
"string",
"null"
]
}
}
},
"minItems": 1,
"uniqueItems": true
}
UsersGetUserByExternalIdResponse
{
"required": [
"user_badges",
"user"
],
"properties": {
"user": {
"type": "object",
"required": [
"id",
"username",
"name",
"avatar_template",
"last_posted_at",
"last_seen_at",
"created_at",
"ignored",
"muted",
"can_ignore_user",
"can_mute_user",
"can_send_private_messages",
"can_send_private_message_to_user",
"trust_level",
"moderator",
"admin",
"title",
"badge_count",
"custom_fields",
"time_read",
"recent_time_read",
"primary_group_id",
"primary_group_name",
"flair_group_id",
"flair_name",
"flair_url",
"flair_bg_color",
"flair_color",
"featured_topic",
"staged",
"can_edit",
"can_edit_username",
"can_edit_email",
"can_edit_name",
"uploaded_avatar_id",
"has_title_badges",
"pending_count",
"profile_view_count",
"second_factor_enabled",
"can_upload_profile_header",
"can_upload_user_card_background",
"post_count",
"can_be_deleted",
"can_delete_all_posts",
"locale",
"muted_category_ids",
"regular_category_ids",
"watched_tags",
"watching_first_post_tags",
"tracked_tags",
"muted_tags",
"tracked_category_ids",
"watched_category_ids",
"watched_first_post_category_ids",
"system_avatar_upload_id",
"system_avatar_template",
"muted_usernames",
"ignored_usernames",
"allowed_pm_usernames",
"mailing_list_posts_per_day",
"can_change_bio",
"can_change_location",
"can_change_website",
"can_change_tracking_preferences",
"user_api_keys",
"user_auth_tokens",
"user_notification_schedule",
"use_logo_small_as_avatar",
"featured_user_badge_ids",
"invited_by",
"groups",
"group_users",
"user_option"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"admin": {
"type": "boolean"
},
"muted": {
"type": "boolean"
},
"title": {
"type": [
"string",
"null"
]
},
"groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"automatic",
"name",
"display_name",
"user_count",
"mentionable_level",
"messageable_level",
"visibility_level",
"primary_group",
"title",
"grant_trust_level",
"incoming_email",
"has_messages",
"flair_url",
"flair_bg_color",
"flair_color",
"bio_raw",
"bio_cooked",
"bio_excerpt",
"public_admission",
"public_exit",
"allow_membership_requests",
"full_name",
"default_notification_level",
"membership_request_template",
"members_visibility_level",
"can_see_members",
"can_admin_group",
"publish_read_state"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"title": {
"type": [
"string",
"null"
]
},
"bio_raw": {
"type": [
"string",
"null"
]
},
"automatic": {
"type": "boolean"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"full_name": {
"type": [
"string",
"null"
]
},
"bio_cooked": {
"type": [
"string",
"null"
]
},
"user_count": {
"type": "integer"
},
"bio_excerpt": {
"type": [
"string",
"null"
]
},
"flair_color": {
"type": [
"string",
"null"
]
},
"public_exit": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"has_messages": {
"type": "boolean"
},
"primary_group": {
"type": "boolean"
},
"flair_bg_color": {
"type": [
"string",
"null"
]
},
"incoming_email": {
"type": [
"string",
"null"
]
},
"can_admin_group": {
"type": "boolean"
},
"can_see_members": {
"type": "boolean"
},
"public_admission": {
"type": "boolean"
},
"visibility_level": {
"type": "integer"
},
"grant_trust_level": {
"type": [
"string",
"null"
]
},
"mentionable_level": {
"type": "integer"
},
"messageable_level": {
"type": "integer"
},
"publish_read_state": {
"type": "boolean"
},
"members_visibility_level": {
"type": "integer"
},
"allow_membership_requests": {
"type": "boolean"
},
"default_notification_level": {
"type": "integer"
},
"membership_request_template": {
"type": [
"string",
"null"
]
}
}
}
},
"locale": {
"type": [
"string",
"null"
]
},
"staged": {
"type": "boolean"
},
"ignored": {
"type": "boolean"
},
"can_edit": {
"type": "boolean"
},
"username": {
"type": "string"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"moderator": {
"type": "boolean"
},
"time_read": {
"type": "integer"
},
"created_at": {
"type": "string"
},
"flair_name": {
"type": [
"string",
"null"
]
},
"invited_by": {
"type": [
"string",
"null"
]
},
"muted_tags": {
"type": "array",
"items": {}
},
"post_count": {
"type": "integer"
},
"badge_count": {
"type": "integer"
},
"flair_color": {
"type": [
"string",
"null"
]
},
"group_users": {
"type": "array",
"items": {
"type": "object",
"required": [
"group_id",
"user_id",
"notification_level"
],
"properties": {
"owner": {
"type": "boolean"
},
"user_id": {
"type": "integer"
},
"group_id": {
"type": "integer"
},
"notification_level": {
"type": "integer"
}
}
}
},
"trust_level": {
"type": "integer"
},
"user_fields": {
"type": "object",
"required": [
"1",
"2"
],
"properties": {
"1": {
"type": [
"string",
"null"
]
},
"2": {
"type": [
"string",
"null"
]
}
}
},
"user_option": {
"type": "object",
"required": [
"user_id",
"mailing_list_mode",
"mailing_list_mode_frequency",
"email_digests",
"email_level",
"email_messages_level",
"external_links_in_new_tab",
"color_scheme_id",
"dark_scheme_id",
"dynamic_favicon",
"enable_quoting",
"enable_defer",
"digest_after_minutes",
"automatically_unpin_topics",
"auto_track_topics_after_msecs",
"notification_level_when_replying",
"new_topic_duration_minutes",
"email_previous_replies",
"email_in_reply_to",
"like_notification_frequency",
"include_tl0_in_digests",
"theme_ids",
"theme_key_seq",
"allow_private_messages",
"enable_allowed_pm_users",
"homepage_id",
"hide_profile_and_presence",
"text_size",
"text_size_seq",
"title_count_mode",
"timezone",
"skip_new_user_tips",
"topics_unread_when_closed"
],
"properties": {
"user_id": {
"type": "integer"
},
"timezone": {
"type": [
"string",
"null"
]
},
"text_size": {
"type": "string"
},
"theme_ids": {
"type": "array",
"items": {}
},
"email_level": {
"type": "integer"
},
"homepage_id": {
"type": [
"string",
"null"
]
},
"seen_popups": {
"type": [
"array",
"null"
]
},
"enable_defer": {
"type": "boolean"
},
"email_digests": {
"type": "boolean"
},
"text_size_seq": {
"type": "integer"
},
"theme_key_seq": {
"type": "integer"
},
"dark_scheme_id": {
"type": [
"string",
"null"
]
},
"enable_quoting": {
"type": "boolean"
},
"color_scheme_id": {
"type": [
"string",
"null"
]
},
"dynamic_favicon": {
"type": "boolean"
},
"default_calendar": {
"type": "string"
},
"title_count_mode": {
"type": "string"
},
"email_in_reply_to": {
"type": "boolean"
},
"mailing_list_mode": {
"type": "boolean"
},
"skip_new_user_tips": {
"type": "boolean"
},
"digest_after_minutes": {
"type": "integer"
},
"email_messages_level": {
"type": "integer"
},
"allow_private_messages": {
"type": "boolean"
},
"email_previous_replies": {
"type": "integer"
},
"include_tl0_in_digests": {
"type": "boolean"
},
"oldest_search_log_date": {
"type": [
"string",
"null"
]
},
"enable_allowed_pm_users": {
"type": "boolean"
},
"external_links_in_new_tab": {
"type": "boolean"
},
"hide_profile_and_presence": {
"type": "boolean"
},
"topics_unread_when_closed": {
"type": "boolean"
},
"automatically_unpin_topics": {
"type": "boolean"
},
"new_topic_duration_minutes": {
"type": "integer"
},
"like_notification_frequency": {
"type": "integer"
},
"mailing_list_mode_frequency": {
"type": "integer"
},
"auto_track_topics_after_msecs": {
"type": "integer"
},
"sidebar_link_to_filtered_list": {
"type": "boolean"
},
"watched_precedence_over_muted": {
"type": [
"boolean",
"null"
]
},
"bookmark_auto_delete_preference": {
"type": "integer"
},
"sidebar_show_count_of_new_items": {
"type": "boolean"
},
"notification_level_when_replying": {
"type": "integer"
}
}
},
"last_seen_at": {
"type": [
"string",
"null"
]
},
"sidebar_tags": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
}
},
"tracked_tags": {
"type": "array",
"items": {}
},
"watched_tags": {
"type": "array",
"items": {}
},
"can_edit_name": {
"type": "boolean"
},
"can_mute_user": {
"type": "boolean"
},
"custom_fields": {
"type": "object",
"properties": {
"first_name": {
"type": [
"string",
"null"
]
}
}
},
"pending_count": {
"type": "integer"
},
"user_api_keys": {
"type": [
"string",
"null"
]
},
"user_passkeys": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
}
},
"can_be_deleted": {
"type": "boolean"
},
"can_change_bio": {
"type": "boolean"
},
"can_edit_email": {
"type": "boolean"
},
"featured_topic": {
"type": [
"string",
"null"
]
},
"flair_bg_color": {
"type": [
"string",
"null"
]
},
"flair_group_id": {
"type": [
"string",
"null"
]
},
"last_posted_at": {
"type": [
"string",
"null"
]
},
"avatar_template": {
"type": "string"
},
"can_ignore_user": {
"type": "boolean"
},
"muted_usernames": {
"type": "array",
"items": {}
},
"has_title_badges": {
"type": "boolean"
},
"primary_group_id": {
"type": [
"string",
"null"
]
},
"recent_time_read": {
"type": "integer"
},
"user_auth_tokens": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"client_ip",
"location",
"browser",
"device",
"os",
"icon",
"created_at",
"seen_at",
"is_active"
],
"properties": {
"id": {
"type": "integer"
},
"os": {
"type": "string"
},
"icon": {
"type": "string"
},
"device": {
"type": "string"
},
"browser": {
"type": "string"
},
"seen_at": {
"type": "string"
},
"location": {
"type": "string"
},
"client_ip": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"created_at": {
"type": "string"
}
}
}
},
"can_edit_username": {
"type": "boolean"
},
"ignored_usernames": {
"type": "array",
"items": {}
},
"can_change_website": {
"type": "boolean"
},
"muted_category_ids": {
"type": "array",
"items": {}
},
"primary_group_name": {
"type": [
"string",
"null"
]
},
"profile_view_count": {
"type": "integer"
},
"uploaded_avatar_id": {
"type": [
"string",
"null"
]
},
"can_change_location": {
"type": "boolean"
},
"pending_posts_count": {
"type": "integer"
},
"allowed_pm_usernames": {
"type": "array",
"items": {}
},
"can_delete_all_posts": {
"type": "boolean"
},
"display_sidebar_tags": {
"type": "boolean"
},
"regular_category_ids": {
"type": "array",
"items": {}
},
"sidebar_category_ids": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
}
},
"tracked_category_ids": {
"type": "array",
"items": {}
},
"watched_category_ids": {
"type": "array",
"items": {}
},
"second_factor_enabled": {
"type": "boolean"
},
"system_avatar_template": {
"type": "string"
},
"featured_user_badge_ids": {
"type": "array",
"items": {}
},
"system_avatar_upload_id": {
"type": [
"string",
"null"
]
},
"use_logo_small_as_avatar": {
"type": "boolean"
},
"watching_first_post_tags": {
"type": "array",
"items": {}
},
"can_send_private_messages": {
"type": "boolean"
},
"can_upload_profile_header": {
"type": "boolean"
},
"mailing_list_posts_per_day": {
"type": "integer"
},
"user_notification_schedule": {
"type": "object",
"required": [
"enabled",
"day_0_start_time",
"day_0_end_time",
"day_1_start_time",
"day_1_end_time",
"day_2_start_time",
"day_2_end_time",
"day_3_start_time",
"day_3_end_time",
"day_4_start_time",
"day_4_end_time",
"day_5_start_time",
"day_5_end_time",
"day_6_start_time",
"day_6_end_time"
],
"properties": {
"enabled": {
"type": "boolean"
},
"day_0_end_time": {
"type": "integer"
},
"day_1_end_time": {
"type": "integer"
},
"day_2_end_time": {
"type": "integer"
},
"day_3_end_time": {
"type": "integer"
},
"day_4_end_time": {
"type": "integer"
},
"day_5_end_time": {
"type": "integer"
},
"day_6_end_time": {
"type": "integer"
},
"day_0_start_time": {
"type": "integer"
},
"day_1_start_time": {
"type": "integer"
},
"day_2_start_time": {
"type": "integer"
},
"day_3_start_time": {
"type": "integer"
},
"day_4_start_time": {
"type": "integer"
},
"day_5_start_time": {
"type": "integer"
},
"day_6_start_time": {
"type": "integer"
}
}
},
"second_factor_backup_enabled": {
"type": "boolean"
},
"can_change_tracking_preferences": {
"type": "boolean"
},
"can_upload_user_card_background": {
"type": "boolean"
},
"watched_first_post_category_ids": {
"type": "array",
"items": {}
},
"can_send_private_message_to_user": {
"type": "boolean"
},
"can_pick_theme_with_custom_homepage": {
"type": "boolean"
}
}
},
"user_badges": {
"type": "array",
"items": {}
}
},
"additionalProperties": false
}
UsersGetUserByIdJsonResponse
{
"required": [
"id",
"username",
"name",
"avatar_template",
"active",
"admin",
"moderator",
"last_seen_at",
"last_emailed_at",
"created_at",
"last_seen_age",
"last_emailed_age",
"created_at_age",
"trust_level",
"manual_locked_trust_level",
"title",
"time_read",
"staged",
"days_visited",
"posts_read_count",
"topics_entered",
"post_count",
"can_send_activation_email",
"can_activate",
"can_deactivate",
"ip_address",
"registration_ip_address",
"can_grant_admin",
"can_revoke_admin",
"can_grant_moderation",
"can_revoke_moderation",
"can_impersonate",
"like_count",
"like_given_count",
"topic_count",
"flags_given_count",
"flags_received_count",
"private_topics_count",
"can_delete_all_posts",
"can_be_deleted",
"can_be_anonymized",
"can_be_merged",
"full_suspend_reason",
"silence_reason",
"primary_group_id",
"badge_count",
"warnings_received_count",
"bounce_score",
"reset_bounce_score_after",
"can_view_action_logs",
"can_disable_second_factor",
"can_delete_sso_record",
"api_key_count",
"single_sign_on_record",
"approved_by",
"suspended_by",
"silenced_by",
"groups",
"external_ids"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": [
"string",
"null"
]
},
"admin": {
"type": "boolean"
},
"title": {
"type": [
"string",
"null"
]
},
"active": {
"type": "boolean"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"automatic",
"name",
"display_name",
"user_count",
"mentionable_level",
"messageable_level",
"visibility_level",
"primary_group",
"title",
"grant_trust_level",
"incoming_email",
"has_messages",
"flair_url",
"flair_bg_color",
"flair_color",
"bio_raw",
"bio_cooked",
"bio_excerpt",
"public_admission",
"public_exit",
"allow_membership_requests",
"full_name",
"default_notification_level",
"membership_request_template",
"members_visibility_level",
"can_see_members",
"can_admin_group",
"publish_read_state"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"title": {
"type": [
"string",
"null"
]
},
"bio_raw": {
"type": [
"string",
"null"
]
},
"automatic": {
"type": "boolean"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"full_name": {
"type": [
"string",
"null"
]
},
"bio_cooked": {
"type": [
"string",
"null"
]
},
"user_count": {
"type": "integer"
},
"bio_excerpt": {
"type": [
"string",
"null"
]
},
"flair_color": {
"type": [
"string",
"null"
]
},
"public_exit": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"has_messages": {
"type": "boolean"
},
"primary_group": {
"type": "boolean"
},
"flair_bg_color": {
"type": [
"string",
"null"
]
},
"flair_group_id": {
"type": [
"string",
"null"
]
},
"incoming_email": {
"type": [
"string",
"null"
]
},
"can_admin_group": {
"type": "boolean"
},
"can_see_members": {
"type": "boolean"
},
"public_admission": {
"type": "boolean"
},
"visibility_level": {
"type": "integer"
},
"grant_trust_level": {
"type": [
"string",
"null"
]
},
"mentionable_level": {
"type": "integer"
},
"messageable_level": {
"type": "integer"
},
"publish_read_state": {
"type": "boolean"
},
"members_visibility_level": {
"type": "integer"
},
"allow_membership_requests": {
"type": "boolean"
},
"default_notification_level": {
"type": "integer"
},
"membership_request_template": {
"type": [
"string",
"null"
]
}
}
}
},
"staged": {
"type": "boolean"
},
"username": {
"type": "string"
},
"moderator": {
"type": "boolean"
},
"time_read": {
"type": "integer"
},
"created_at": {
"type": "string"
},
"ip_address": {
"type": "string"
},
"like_count": {
"type": "integer"
},
"post_count": {
"type": "integer"
},
"approved_by": {
"type": [
"object",
"null"
],
"required": [
"id",
"username",
"name",
"avatar_template"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"username": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
},
"additionalProperties": false
},
"badge_count": {
"type": "integer"
},
"silenced_by": {
"type": [
"string",
"null"
]
},
"topic_count": {
"type": "integer"
},
"trust_level": {
"type": "integer"
},
"bounce_score": {
"type": [
"integer",
"null"
]
},
"can_activate": {
"type": "boolean"
},
"days_visited": {
"type": "integer"
},
"external_ids": {
"type": "object"
},
"last_seen_at": {
"type": [
"string",
"null"
]
},
"next_penalty": {
"type": "string"
},
"suspended_by": {
"type": [
"string",
"null"
]
},
"api_key_count": {
"type": "integer"
},
"can_be_merged": {
"type": "boolean"
},
"last_seen_age": {
"type": [
"number",
"null"
]
},
"can_be_deleted": {
"type": "boolean"
},
"can_deactivate": {
"type": "boolean"
},
"created_at_age": {
"type": [
"number",
"null"
]
},
"penalty_counts": {
"type": "object",
"required": [
"silenced",
"suspended"
],
"properties": {
"silenced": {
"type": "integer"
},
"suspended": {
"type": "integer"
}
}
},
"silence_reason": {
"type": [
"string",
"null"
]
},
"topics_entered": {
"type": "integer"
},
"avatar_template": {
"type": "string"
},
"can_grant_admin": {
"type": "boolean"
},
"can_impersonate": {
"type": "boolean"
},
"last_emailed_at": {
"type": [
"string",
"null"
]
},
"can_revoke_admin": {
"type": "boolean"
},
"last_emailed_age": {
"type": [
"number",
"null"
]
},
"like_given_count": {
"type": "integer"
},
"post_edits_count": {
"type": [
"integer",
"null"
]
},
"posts_read_count": {
"type": "integer"
},
"primary_group_id": {
"type": [
"string",
"null"
]
},
"tl3_requirements": {
"type": "object",
"required": [
"time_period",
"requirements_met",
"requirements_lost",
"trust_level_locked",
"on_grace_period",
"days_visited",
"min_days_visited",
"num_topics_replied_to",
"min_topics_replied_to",
"topics_viewed",
"min_topics_viewed",
"posts_read",
"min_posts_read",
"topics_viewed_all_time",
"min_topics_viewed_all_time",
"posts_read_all_time",
"min_posts_read_all_time",
"num_flagged_posts",
"max_flagged_posts",
"num_flagged_by_users",
"max_flagged_by_users",
"num_likes_given",
"min_likes_given",
"num_likes_received",
"min_likes_received",
"num_likes_received_days",
"min_likes_received_days",
"num_likes_received_users",
"min_likes_received_users",
"penalty_counts"
],
"properties": {
"posts_read": {
"type": "integer"
},
"time_period": {
"type": "integer"
},
"days_visited": {
"type": "integer"
},
"topics_viewed": {
"type": "integer"
},
"min_posts_read": {
"type": "integer"
},
"penalty_counts": {
"type": "object",
"required": [
"silenced",
"suspended",
"total"
],
"properties": {
"total": {
"type": "integer"
},
"silenced": {
"type": "integer"
},
"suspended": {
"type": "integer"
}
}
},
"min_likes_given": {
"type": "integer"
},
"num_likes_given": {
"type": "integer"
},
"on_grace_period": {
"type": "boolean"
},
"min_days_visited": {
"type": "integer"
},
"requirements_met": {
"type": "boolean"
},
"max_flagged_posts": {
"type": "integer"
},
"min_topics_viewed": {
"type": "integer"
},
"num_flagged_posts": {
"type": "integer"
},
"requirements_lost": {
"type": "boolean"
},
"min_likes_received": {
"type": "integer"
},
"num_likes_received": {
"type": "integer"
},
"trust_level_locked": {
"type": "boolean"
},
"posts_read_all_time": {
"type": "integer"
},
"max_flagged_by_users": {
"type": "integer"
},
"num_flagged_by_users": {
"type": "integer"
},
"min_topics_replied_to": {
"type": "integer"
},
"num_topics_replied_to": {
"type": "integer"
},
"topics_viewed_all_time": {
"type": "integer"
},
"min_likes_received_days": {
"type": "integer"
},
"min_posts_read_all_time": {
"type": "integer"
},
"num_likes_received_days": {
"type": "integer"
},
"min_likes_received_users": {
"type": "integer"
},
"num_likes_received_users": {
"type": "integer"
},
"min_topics_viewed_all_time": {
"type": "integer"
}
}
},
"can_be_anonymized": {
"type": "boolean"
},
"flags_given_count": {
"type": "integer"
},
"associated_accounts": {
"type": "array",
"items": {}
},
"full_suspend_reason": {
"type": [
"string",
"null"
]
},
"can_delete_all_posts": {
"type": "boolean"
},
"can_grant_moderation": {
"type": "boolean"
},
"can_view_action_logs": {
"type": "boolean"
},
"flags_received_count": {
"type": "integer"
},
"private_topics_count": {
"type": "integer"
},
"can_delete_sso_record": {
"type": "boolean"
},
"can_revoke_moderation": {
"type": "boolean"
},
"single_sign_on_record": {
"type": [
"string",
"null"
]
},
"registration_ip_address": {
"type": [
"string",
"null"
]
},
"warnings_received_count": {
"type": "integer"
},
"reset_bounce_score_after": {
"type": [
"string",
"null"
]
},
"can_disable_second_factor": {
"type": "boolean"
},
"can_send_activation_email": {
"type": "boolean"
},
"manual_locked_trust_level": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}
UsersGetUserByUsernameResponse
{
"required": [
"user_badges",
"user"
],
"properties": {
"user": {
"type": "object",
"required": [
"id",
"username",
"name",
"avatar_template",
"last_posted_at",
"last_seen_at",
"created_at",
"ignored",
"muted",
"can_ignore_user",
"can_mute_user",
"can_send_private_messages",
"can_send_private_message_to_user",
"trust_level",
"moderator",
"admin",
"title",
"badge_count",
"custom_fields",
"time_read",
"recent_time_read",
"primary_group_id",
"primary_group_name",
"flair_group_id",
"flair_name",
"flair_url",
"flair_bg_color",
"flair_color",
"featured_topic",
"staged",
"can_edit",
"can_edit_username",
"can_edit_email",
"can_edit_name",
"uploaded_avatar_id",
"has_title_badges",
"pending_count",
"profile_view_count",
"second_factor_enabled",
"can_upload_profile_header",
"can_upload_user_card_background",
"post_count",
"can_be_deleted",
"can_delete_all_posts",
"locale",
"muted_category_ids",
"regular_category_ids",
"watched_tags",
"watching_first_post_tags",
"tracked_tags",
"muted_tags",
"tracked_category_ids",
"watched_category_ids",
"watched_first_post_category_ids",
"system_avatar_upload_id",
"system_avatar_template",
"muted_usernames",
"ignored_usernames",
"allowed_pm_usernames",
"mailing_list_posts_per_day",
"can_change_bio",
"can_change_location",
"can_change_website",
"can_change_tracking_preferences",
"user_api_keys",
"user_auth_tokens",
"user_notification_schedule",
"use_logo_small_as_avatar",
"featured_user_badge_ids",
"invited_by",
"groups",
"group_users",
"user_option"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"admin": {
"type": "boolean"
},
"muted": {
"type": "boolean"
},
"title": {
"type": [
"string",
"null"
]
},
"groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"automatic",
"name",
"display_name",
"user_count",
"mentionable_level",
"messageable_level",
"visibility_level",
"primary_group",
"title",
"grant_trust_level",
"incoming_email",
"has_messages",
"flair_url",
"flair_bg_color",
"flair_color",
"bio_raw",
"bio_cooked",
"bio_excerpt",
"public_admission",
"public_exit",
"allow_membership_requests",
"full_name",
"default_notification_level",
"membership_request_template",
"members_visibility_level",
"can_see_members",
"can_admin_group",
"publish_read_state"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"title": {
"type": [
"string",
"null"
]
},
"bio_raw": {
"type": [
"string",
"null"
]
},
"automatic": {
"type": "boolean"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"full_name": {
"type": [
"string",
"null"
]
},
"bio_cooked": {
"type": [
"string",
"null"
]
},
"user_count": {
"type": "integer"
},
"bio_excerpt": {
"type": [
"string",
"null"
]
},
"flair_color": {
"type": [
"string",
"null"
]
},
"public_exit": {
"type": "boolean"
},
"display_name": {
"type": "string"
},
"has_messages": {
"type": "boolean"
},
"primary_group": {
"type": "boolean"
},
"flair_bg_color": {
"type": [
"string",
"null"
]
},
"incoming_email": {
"type": [
"string",
"null"
]
},
"can_admin_group": {
"type": "boolean"
},
"can_see_members": {
"type": "boolean"
},
"public_admission": {
"type": "boolean"
},
"visibility_level": {
"type": "integer"
},
"grant_trust_level": {
"type": [
"string",
"null"
]
},
"mentionable_level": {
"type": "integer"
},
"messageable_level": {
"type": "integer"
},
"publish_read_state": {
"type": "boolean"
},
"members_visibility_level": {
"type": "integer"
},
"allow_membership_requests": {
"type": "boolean"
},
"default_notification_level": {
"type": "integer"
},
"membership_request_template": {
"type": [
"string",
"null"
]
}
}
}
},
"locale": {
"type": [
"string",
"null"
]
},
"staged": {
"type": "boolean"
},
"ignored": {
"type": "boolean"
},
"can_edit": {
"type": "boolean"
},
"username": {
"type": "string"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"moderator": {
"type": "boolean"
},
"time_read": {
"type": "integer"
},
"created_at": {
"type": "string"
},
"flair_name": {
"type": [
"string",
"null"
]
},
"invited_by": {
"type": [
"string",
"null"
]
},
"muted_tags": {
"type": "array",
"items": {}
},
"post_count": {
"type": "integer"
},
"badge_count": {
"type": "integer"
},
"flair_color": {
"type": [
"string",
"null"
]
},
"group_users": {
"type": "array",
"items": {
"type": "object",
"required": [
"group_id",
"user_id",
"notification_level"
],
"properties": {
"owner": {
"type": "boolean"
},
"user_id": {
"type": "integer"
},
"group_id": {
"type": "integer"
},
"notification_level": {
"type": "integer"
}
}
}
},
"trust_level": {
"type": "integer"
},
"user_fields": {
"type": "object",
"required": [
"1",
"2"
],
"properties": {
"1": {
"type": [
"string",
"null"
]
},
"2": {
"type": [
"string",
"null"
]
}
}
},
"user_option": {
"type": "object",
"required": [
"user_id",
"mailing_list_mode",
"mailing_list_mode_frequency",
"email_digests",
"email_level",
"email_messages_level",
"external_links_in_new_tab",
"color_scheme_id",
"dark_scheme_id",
"dynamic_favicon",
"enable_quoting",
"enable_defer",
"digest_after_minutes",
"automatically_unpin_topics",
"auto_track_topics_after_msecs",
"notification_level_when_replying",
"new_topic_duration_minutes",
"email_previous_replies",
"email_in_reply_to",
"like_notification_frequency",
"include_tl0_in_digests",
"theme_ids",
"theme_key_seq",
"allow_private_messages",
"enable_allowed_pm_users",
"homepage_id",
"hide_profile_and_presence",
"text_size",
"text_size_seq",
"title_count_mode",
"timezone",
"skip_new_user_tips",
"topics_unread_when_closed"
],
"properties": {
"user_id": {
"type": "integer"
},
"timezone": {
"type": [
"string",
"null"
]
},
"text_size": {
"type": "string"
},
"theme_ids": {
"type": "array",
"items": {}
},
"email_level": {
"type": "integer"
},
"homepage_id": {
"type": [
"string",
"null"
]
},
"seen_popups": {
"type": [
"array",
"null"
]
},
"enable_defer": {
"type": "boolean"
},
"email_digests": {
"type": "boolean"
},
"text_size_seq": {
"type": "integer"
},
"theme_key_seq": {
"type": "integer"
},
"dark_scheme_id": {
"type": [
"string",
"null"
]
},
"enable_quoting": {
"type": "boolean"
},
"color_scheme_id": {
"type": [
"string",
"null"
]
},
"dynamic_favicon": {
"type": "boolean"
},
"default_calendar": {
"type": "string"
},
"title_count_mode": {
"type": "string"
},
"email_in_reply_to": {
"type": "boolean"
},
"mailing_list_mode": {
"type": "boolean"
},
"skip_new_user_tips": {
"type": "boolean"
},
"digest_after_minutes": {
"type": "integer"
},
"email_messages_level": {
"type": "integer"
},
"allow_private_messages": {
"type": "boolean"
},
"email_previous_replies": {
"type": "integer"
},
"include_tl0_in_digests": {
"type": "boolean"
},
"oldest_search_log_date": {
"type": [
"string",
"null"
]
},
"enable_allowed_pm_users": {
"type": "boolean"
},
"external_links_in_new_tab": {
"type": "boolean"
},
"hide_profile_and_presence": {
"type": "boolean"
},
"topics_unread_when_closed": {
"type": "boolean"
},
"automatically_unpin_topics": {
"type": "boolean"
},
"new_topic_duration_minutes": {
"type": "integer"
},
"like_notification_frequency": {
"type": "integer"
},
"mailing_list_mode_frequency": {
"type": "integer"
},
"auto_track_topics_after_msecs": {
"type": "integer"
},
"sidebar_link_to_filtered_list": {
"type": "boolean"
},
"watched_precedence_over_muted": {
"type": [
"boolean",
"null"
]
},
"bookmark_auto_delete_preference": {
"type": "integer"
},
"sidebar_show_count_of_new_items": {
"type": "boolean"
},
"notification_level_when_replying": {
"type": "integer"
}
}
},
"last_seen_at": {
"type": [
"string",
"null"
]
},
"sidebar_tags": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
}
},
"tracked_tags": {
"type": "array",
"items": {}
},
"watched_tags": {
"type": "array",
"items": {}
},
"can_edit_name": {
"type": "boolean"
},
"can_mute_user": {
"type": "boolean"
},
"custom_fields": {
"type": "object",
"properties": {
"first_name": {
"type": [
"string",
"null"
]
}
}
},
"pending_count": {
"type": "integer"
},
"user_api_keys": {
"type": [
"string",
"null"
]
},
"user_passkeys": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
}
},
"can_be_deleted": {
"type": "boolean"
},
"can_change_bio": {
"type": "boolean"
},
"can_edit_email": {
"type": "boolean"
},
"featured_topic": {
"type": [
"string",
"null"
]
},
"flair_bg_color": {
"type": [
"string",
"null"
]
},
"flair_group_id": {
"type": [
"string",
"null"
]
},
"last_posted_at": {
"type": [
"string",
"null"
]
},
"avatar_template": {
"type": "string"
},
"can_ignore_user": {
"type": "boolean"
},
"muted_usernames": {
"type": "array",
"items": {}
},
"has_title_badges": {
"type": "boolean"
},
"primary_group_id": {
"type": [
"string",
"null"
]
},
"recent_time_read": {
"type": "integer"
},
"user_auth_tokens": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"client_ip",
"location",
"browser",
"device",
"os",
"icon",
"created_at",
"seen_at",
"is_active"
],
"properties": {
"id": {
"type": "integer"
},
"os": {
"type": "string"
},
"icon": {
"type": "string"
},
"device": {
"type": "string"
},
"browser": {
"type": "string"
},
"seen_at": {
"type": "string"
},
"location": {
"type": "string"
},
"client_ip": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"created_at": {
"type": "string"
}
}
}
},
"can_edit_username": {
"type": "boolean"
},
"ignored_usernames": {
"type": "array",
"items": {}
},
"can_change_website": {
"type": "boolean"
},
"muted_category_ids": {
"type": "array",
"items": {}
},
"primary_group_name": {
"type": [
"string",
"null"
]
},
"profile_view_count": {
"type": "integer"
},
"uploaded_avatar_id": {
"type": [
"string",
"null"
]
},
"can_change_location": {
"type": "boolean"
},
"pending_posts_count": {
"type": "integer"
},
"allowed_pm_usernames": {
"type": "array",
"items": {}
},
"can_delete_all_posts": {
"type": "boolean"
},
"display_sidebar_tags": {
"type": "boolean"
},
"regular_category_ids": {
"type": "array",
"items": {}
},
"sidebar_category_ids": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
}
},
"tracked_category_ids": {
"type": "array",
"items": {}
},
"watched_category_ids": {
"type": "array",
"items": {}
},
"second_factor_enabled": {
"type": "boolean"
},
"system_avatar_template": {
"type": "string"
},
"featured_user_badge_ids": {
"type": "array",
"items": {}
},
"system_avatar_upload_id": {
"type": [
"string",
"null"
]
},
"use_logo_small_as_avatar": {
"type": "boolean"
},
"watching_first_post_tags": {
"type": "array",
"items": {}
},
"can_send_private_messages": {
"type": "boolean"
},
"can_upload_profile_header": {
"type": "boolean"
},
"mailing_list_posts_per_day": {
"type": "integer"
},
"user_notification_schedule": {
"type": "object",
"required": [
"enabled",
"day_0_start_time",
"day_0_end_time",
"day_1_start_time",
"day_1_end_time",
"day_2_start_time",
"day_2_end_time",
"day_3_start_time",
"day_3_end_time",
"day_4_start_time",
"day_4_end_time",
"day_5_start_time",
"day_5_end_time",
"day_6_start_time",
"day_6_end_time"
],
"properties": {
"enabled": {
"type": "boolean"
},
"day_0_end_time": {
"type": "integer"
},
"day_1_end_time": {
"type": "integer"
},
"day_2_end_time": {
"type": "integer"
},
"day_3_end_time": {
"type": "integer"
},
"day_4_end_time": {
"type": "integer"
},
"day_5_end_time": {
"type": "integer"
},
"day_6_end_time": {
"type": "integer"
},
"day_0_start_time": {
"type": "integer"
},
"day_1_start_time": {
"type": "integer"
},
"day_2_start_time": {
"type": "integer"
},
"day_3_start_time": {
"type": "integer"
},
"day_4_start_time": {
"type": "integer"
},
"day_5_start_time": {
"type": "integer"
},
"day_6_start_time": {
"type": "integer"
}
}
},
"second_factor_backup_enabled": {
"type": "boolean"
},
"can_change_tracking_preferences": {
"type": "boolean"
},
"can_upload_user_card_background": {
"type": "boolean"
},
"watched_first_post_category_ids": {
"type": "array",
"items": {}
},
"can_send_private_message_to_user": {
"type": "boolean"
},
"can_pick_theme_with_custom_homepage": {
"type": "boolean"
}
}
},
"user_badges": {
"type": "array",
"items": {}
}
},
"additionalProperties": false
}
UsersListPublicUserResponse
{
"required": [
"directory_items",
"meta"
],
"properties": {
"meta": {
"type": "object",
"required": [
"last_updated_at",
"total_rows_directory_items",
"load_more_directory_items"
],
"properties": {
"last_updated_at": {
"type": [
"string",
"null"
]
},
"load_more_directory_items": {
"type": "string"
},
"total_rows_directory_items": {
"type": "integer"
}
}
},
"directory_items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"likes_received",
"likes_given",
"topics_entered",
"topic_count",
"post_count",
"posts_read",
"days_visited",
"user"
],
"properties": {
"id": {
"type": "integer"
},
"user": {
"type": "object",
"required": [
"id",
"username",
"name",
"avatar_template",
"title"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": [
"string",
"null"
]
},
"title": {
"type": [
"string",
"null"
]
},
"username": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
}
},
"post_count": {
"type": "integer"
},
"posts_read": {
"type": "integer"
},
"likes_given": {
"type": "integer"
},
"topic_count": {
"type": "integer"
},
"days_visited": {
"type": "integer"
},
"likes_received": {
"type": "integer"
},
"topics_entered": {
"type": "integer"
}
}
}
}
},
"additionalProperties": false
}
UsersListUserActionsResponse
{
"required": [
"user_actions"
],
"properties": {
"user_actions": {
"type": "array",
"items": {
"type": "object",
"required": [
"excerpt",
"action_type",
"created_at",
"avatar_template",
"acting_avatar_template",
"slug",
"topic_id",
"target_user_id",
"target_name",
"target_username",
"post_number",
"post_id",
"username",
"name",
"user_id",
"acting_username",
"acting_name",
"acting_user_id",
"title",
"deleted",
"hidden",
"post_type",
"action_code",
"category_id",
"closed",
"archived"
],
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"slug": {
"type": "string"
},
"title": {
"type": "string"
},
"closed": {
"type": "boolean"
},
"hidden": {
"type": [
"string",
"null"
]
},
"deleted": {
"type": "boolean"
},
"excerpt": {
"type": "string"
},
"post_id": {
"type": [
"string",
"null"
]
},
"user_id": {
"type": "integer"
},
"archived": {
"type": "boolean"
},
"topic_id": {
"type": "integer"
},
"username": {
"type": "string"
},
"post_type": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string"
},
"acting_name": {
"type": [
"string",
"null"
]
},
"action_code": {
"type": [
"string",
"null"
]
},
"action_type": {
"type": "integer"
},
"category_id": {
"type": "integer"
},
"post_number": {
"type": "integer"
},
"target_name": {
"type": [
"string",
"null"
]
},
"acting_user_id": {
"type": "integer"
},
"target_user_id": {
"type": "integer"
},
"acting_username": {
"type": "string"
},
"avatar_template": {
"type": "string"
},
"target_username": {
"type": "string"
},
"acting_avatar_template": {
"type": "string"
}
}
}
}
},
"additionalProperties": false
}
UsersLogOutUserActionResponse
{
"required": [
"success"
],
"properties": {
"success": {
"type": "string",
"example": "OK"
}
},
"additionalProperties": false
}
UsersRefreshGravatarPostResponse
{
"required": [
"gravatar_upload_id",
"gravatar_avatar_template"
],
"properties": {
"gravatar_upload_id": {
"type": [
"integer",
"null"
]
},
"gravatar_avatar_template": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}
UsersSendPasswordResetEmailRequest
{
"required": [
"login"
],
"properties": {
"login": {
"type": "string"
}
},
"additionalProperties": false
}
UsersSendPasswordResetEmailResponse
{
"required": [
"success",
"user_found"
],
"properties": {
"success": {
"type": "string"
},
"user_found": {
"type": "boolean"
}
},
"additionalProperties": false
}
UsersSilenceByIdRequest
{
"properties": {
"reason": {
"type": "string"
},
"message": {
"type": "string",
"description": "Will send an email with this message when present"
},
"post_action": {
"type": "string",
"example": "delete"
},
"silenced_till": {
"type": "string",
"example": "2022-06-01T08:00:00.000Z"
}
},
"additionalProperties": false
}
UsersSilenceByIdResponse
{
"required": [
"silence"
],
"properties": {
"silence": {
"type": "object",
"required": [
"silenced",
"silence_reason",
"silenced_till",
"silenced_at",
"silenced_by"
],
"properties": {
"silenced": {
"type": "boolean"
},
"silenced_at": {
"type": "string"
},
"silenced_by": {
"type": "object",
"required": [
"id",
"username",
"name",
"avatar_template"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"username": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
}
},
"silenced_till": {
"type": "string"
},
"silence_reason": {
"type": "string"
}
}
}
},
"additionalProperties": false
}
UsersSuspendByIdJsonRequest
{
"required": [
"suspend_until",
"reason"
],
"properties": {
"reason": {
"type": "string"
},
"message": {
"type": "string",
"description": "Will send an email with this message when present"
},
"post_action": {
"type": "string",
"example": "delete"
},
"suspend_until": {
"type": "string",
"example": "2121-02-22"
}
},
"additionalProperties": false
}
UsersSuspendByIdJsonResponse
{
"required": [
"suspension"
],
"properties": {
"suspension": {
"type": "object",
"required": [
"suspend_reason",
"full_suspend_reason",
"suspended_till",
"suspended_at",
"suspended_by"
],
"properties": {
"suspended_at": {
"type": "string"
},
"suspended_by": {
"type": "object",
"required": [
"id",
"username",
"name",
"avatar_template"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"username": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
}
},
"suspend_reason": {
"type": "string"
},
"suspended_till": {
"type": "string"
},
"full_suspend_reason": {
"type": "string"
}
}
}
},
"additionalProperties": false
}
UsersUpdateAvatarRequest
{
"required": [
"upload_id",
"type"
],
"properties": {
"type": {
"enum": [
"uploaded",
"custom",
"gravatar",
"system"
],
"type": "string"
},
"upload_id": {
"type": "integer"
}
},
"additionalProperties": false
}
UsersUpdateAvatarResponse
{
"required": [
"success"
],
"properties": {
"success": {
"type": "string",
"example": "OK"
}
},
"additionalProperties": false
}
UsersUpdateEmailPreferencesRequest
{
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email"
}
},
"additionalProperties": false
}
UsersUpdatePreferencesJsonRequest
{
"required": [
"new_username"
],
"properties": {
"new_username": {
"type": "string"
}
},
"additionalProperties": false
}
UsersUpdateUserDetailsRequest
{
"properties": {
"name": {
"type": "string"
},
"external_ids": {
"type": "object"
}
},
"additionalProperties": false
}
UsersUpdateUserDetailsResponse
{
"required": [
"success",
"user"
],
"properties": {
"user": {
"type": "object"
},
"success": {
"type": "string"
}
},
"additionalProperties": false
}