Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://{defaultHost}
/admin/backups.json
success response
GET /admin/backups.json
/admin/backups.json
application/json
BackupsCreateBackupRequestRequest
success response
POST /admin/backups.json
/admin/backups/{filename}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| filename | path | required | string | — |
| token | query | required | string | — |
success response
GET /admin/backups/{filename}
/admin/backups/{filename}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| filename | path | required | string | — |
success response
PUT /admin/backups/{filename}
/admin/badges.json
success response
GET /admin/badges.json
/admin/badges.json
application/json
BadgesCreateBadgeRequest
success response
POST /admin/badges.json
/admin/badges/{id}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | — |
success response
DELETE /admin/badges/{id}.json
/admin/badges/{id}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | — |
application/json
BadgesUpdateBadgeByIdJsonRequest
success response
PUT /admin/badges/{id}.json
/user-badges/{username}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| username | path | required | string | — |
success response
GET /user-badges/{username}.json
/c/{id}/show.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | — |
response
GET /c/{id}/show.json
/c/{slug}/{id}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| slug | path | required | string | — |
| id | path | required | integer | — |
success response
GET /c/{slug}/{id}.json
/categories.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| include_subcategories | query | optional | boolean | — |
success response
GET /categories.json
/categories.json
application/json
CategoriesCreateCategoryRequestRequest
success response
POST /categories.json
/categories/{id}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | — |
application/json
CategoriesUpdateCategoryByIdJsonRequest
success response
PUT /categories/{id}.json
/admin/groups.json
application/json
GroupsCreateNewGroupRequest
group created
POST /admin/groups.json
/admin/groups/{id}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | — |
response
DELETE /admin/groups/{id}.json
/groups.json
response
GET /groups.json
/groups/{id}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | Use group name instead of id |
success response
GET /groups/{id}.json
/groups/{id}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | — |
application/json
GroupsUpdateGroupByIdJsonRequest
success response
PUT /groups/{id}.json
/groups/{id}/members.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | — |
application/json
GroupsRemoveMembersRequest
success response
DELETE /groups/{id}/members.json
/groups/{id}/members.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | Use group name instead of id |
success response
GET /groups/{id}/members.json
/groups/{id}/members.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | — |
application/json
GroupsAddMembersToGroupRequest
success response
PUT /groups/{id}/members.json
/invites.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| Api-Key | header | required | string | — |
| Api-Username | header | required | string | — |
application/json
InvitesCreateInviteRequest
| Property | Type | Required |
|---|---|---|
| string | optional | |
| topic_id | integer | optional |
| group_ids | string | optional |
| expires_at | string | optional |
| skip_email | boolean | optional |
| group_names | string | optional |
| custom_message | string | optional |
| max_redemptions_allowed | integer | optional |
success response
POST /invites.json
/invites/create-multiple.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| Api-Key | header | required | string | — |
| Api-Username | header | required | string | — |
application/json
InvitesCreateMultipleInvitesRequest
| Property | Type | Required |
|---|---|---|
| string | optional | |
| topic_id | integer | optional |
| group_ids | string | optional |
| expires_at | string | optional |
| skip_email | boolean | optional |
| group_names | string | optional |
| custom_message | string | optional |
| max_redemptions_allowed | integer | optional |
success response
POST /invites/create-multiple.json
/notifications.json
notifications
GET /notifications.json
/notifications/mark-read.json
application/json
NotificationsMarkAsReadRequest
| Property | Type | Required |
|---|---|---|
| id | integer | optional |
notifications marked read
PUT /notifications/mark-read.json
/post_actions.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| Api-Key | header | required | string | — |
| Api-Username | header | required | string | — |
application/json
PostsLikePostActionRequest
| Property | Type | Required |
|---|---|---|
| id | integer | required |
| flag_topic | boolean | optional |
| post_action_type_id | integer | required |
post updated
POST /post_actions.json
/posts.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| Api-Key | header | required | string | — |
| Api-Username | header | required | string | — |
| before | query | optional | string | Load posts with an id lower than this value. Useful for pagination. |
latest posts
GET /posts.json
/posts.json
application/json
PostsCreateTopicPostMessageRequest
post created
POST /posts.json
/posts/{id}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | — |
application/json
PostsDeleteSinglePostRequest
success response
DELETE /posts/{id}.json
/posts/{id}.json
This endpoint can be used to get the number of likes on a post using the
actions_summary property in the response. actions_summary responses
with the id of 2 signify a like. If there are no actions_summary
items with the id of 2, that means there are 0 likes. Other ids likely
refer to various different flag types.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | — |
single post
GET /posts/{id}.json
/posts/{id}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | — |
application/json
PostsUpdateSinglePostJsonRequest
post updated
PUT /posts/{id}.json
/posts/{id}/locked.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| Api-Key | header | required | string | — |
| Api-Username | header | required | string | — |
| id | path | required | string | — |
application/json
PostsLockPostActionRequest
| Property | Type | Required |
|---|---|---|
| locked | string | required |
post updated
PUT /posts/{id}/locked.json
/posts/{id}/replies.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | — |
post replies
GET /posts/{id}/replies.json
/topics/private-messages-sent/{username}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| username | path | required | string | — |
private messages
GET /topics/private-messages-sent/{username}.json
/topics/private-messages/{username}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| username | path | required | string | — |
private messages
GET /topics/private-messages/{username}.json
/search.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| q | query | optional | string | The query string needs to be url encoded and is made up of the following options:
If you are using cURL you can use the |
| page | query | optional | integer | — |
success response
GET /search.json
/site.json
Can be used to fetch all categories and subcategories
success response
GET /site.json
/site/basic-info.json
Can be used to fetch basic info about a site
success response
GET /site/basic-info.json
/tag/{name}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| name | path | required | string | — |
notifications
GET /tag/{name}.json
/tag_groups.json
tags
GET /tag_groups.json
/tag_groups.json
application/json
TagsCreateTagGroupRequest
| Property | Type | Required |
|---|---|---|
| name | string | required |
tag group created
POST /tag_groups.json
/tag_groups/{id}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | — |
notifications
GET /tag_groups/{id}.json
/tag_groups/{id}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | — |
application/json
TagsUpdateTagGroupRequest
| Property | Type | Required |
|---|---|---|
| name | string | optional |
Tag group updated
PUT /tag_groups/{id}.json
/tags.json
notifications
GET /tags.json
/latest.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| Api-Key | header | required | string | — |
| Api-Username | header | required | string | — |
| order | query | optional | string | Enum: |
| ascending | query | optional | string | Defaults to |
topic updated
GET /latest.json
/t/-/{id}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| Api-Key | header | required | string | — |
| Api-Username | header | required | string | — |
| id | path | required | string | — |
application/json
TopicsUpdateTopicByIdJsonRequest
| Property | Type | Required |
|---|---|---|
| topic | object | optional |
| └ title | string | optional |
| └ category_id | integer | optional |
topic updated
PUT /t/-/{id}.json
/t/external_id/{external_id}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| external_id | path | required | string | — |
redirects to /t/{topic_id}.json
GET /t/external_id/{external_id}.json
/t/{id}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| Api-Key | header | required | string | — |
| Api-Username | header | required | string | — |
| id | path | required | string | — |
specific posts
DELETE /t/{id}.json
/t/{id}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| Api-Key | header | required | string | — |
| Api-Username | header | required | string | — |
| id | path | required | string | — |
specific posts
GET /t/{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
}