openapi: 3.2.0 info: title: WordPress.com REST API — wp/v2 namespace Feedback API version: v2 description: Derived by API Evangelist from the WordPress.com REST API route index published at https://public-api.wordpress.com/wp/v2/. Paths, HTTP methods, and parameter names/types/descriptions/defaults are taken verbatim from that index. Response schemas are not published in the route index, so successful responses are described but not schematised; the error envelope was observed live on public-api.wordpress.com. contact: name: Automattic url: https://developer.wordpress.com/docs/api/ x-derived-from: https://public-api.wordpress.com/wp/v2/ x-derived-by: API Evangelist enrichment pipeline servers: - url: https://public-api.wordpress.com security: - bearerAuth: [] tags: - name: feedback paths: /wp/v2/sites/{wpcom_site}/feedback: get: operationId: getWpV2SitesbyWpcomSiteFeedback summary: GET /wp/v2/sites/{wpcom_site}/feedback tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: modified_after in: query required: false schema: type: string format: date-time description: Limit response to posts modified after a given ISO8601 compliant date. - name: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - name: modified_before in: query required: false schema: type: string format: date-time description: Limit response to posts modified before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date description: Sort collection by post attribute. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. - name: status in: query required: false schema: type: array default: publish items: type: string description: Limit result set to posts assigned one or more statuses. - name: parent in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to items with particular parent IDs. - name: parent_exclude in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to all items except those of a particular parent ID. - name: source in: query required: false schema: type: integer description: Limit result set to feedback submitted from a particular source post ID. - name: is_unread in: query required: false schema: type: boolean description: Limit result set to read or unread feedback items. - name: is_test in: query required: false schema: type: boolean description: Limit result set to test responses (from form preview) or exclude them. - name: invalid_ids in: query required: false schema: type: array default: [] items: type: integer description: List of item IDs to include in results regardless of filters. - name: fields_format in: query required: false schema: type: string enum: - label-value - collection default: label-value description: Format for the fields data in the response. post: operationId: postWpV2SitesbyWpcomSiteFeedback summary: POST /wp/v2/sites/{wpcom_site}/feedback tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - spam description: A named status for the post. comment_status: type: string enum: - open - closed description: Whether or not comments are open on the post. ping_status: type: string enum: - open - closed description: Whether or not the post can be pinged. /wp/v2/sites/{wpcom_site}/feedback/bulk_actions: post: operationId: postWpV2SitesbyWpcomSiteFeedbackBulkActions summary: POST /wp/v2/sites/{wpcom_site}/feedback/bulk_actions tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: action: type: string enum: - mark_as_spam - mark_as_not_spam post_ids: type: array items: type: integer required: - action - post_ids /wp/v2/sites/{wpcom_site}/feedback/config: get: operationId: getWpV2SitesbyWpcomSiteFeedbackConfig summary: GET /wp/v2/sites/{wpcom_site}/feedback/config tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wp/v2/sites/{wpcom_site}/feedback/counts: get: operationId: getWpV2SitesbyWpcomSiteFeedbackCounts summary: GET /wp/v2/sites/{wpcom_site}/feedback/counts tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: parent in: query required: false schema: type: integer description: Limit results to those of a specific parent ID. - name: before in: query required: false schema: type: string format: date-time description: Limit results to feedback published before a given ISO8601 compliant date. - name: after in: query required: false schema: type: string format: date-time description: Limit results to feedback published after a given ISO8601 compliant date. - name: is_unread in: query required: false schema: type: boolean description: Limit results to read or unread feedback items. - name: is_test in: query required: false schema: type: boolean description: Limit results to test responses or exclude them. - name: source in: query required: false schema: type: integer description: Limit results to feedback submitted from a specific source post ID. /wp/v2/sites/{wpcom_site}/feedback/dismiss-classic-forms-notice: post: operationId: postWpV2SitesbyWpcomSiteFeedbackDismissClassicFormsNotice summary: POST /wp/v2/sites/{wpcom_site}/feedback/dismiss-classic-forms-notice tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wp/v2/sites/{wpcom_site}/feedback/filters: get: operationId: getWpV2SitesbyWpcomSiteFeedbackFilters summary: GET /wp/v2/sites/{wpcom_site}/feedback/filters tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wp/v2/sites/{wpcom_site}/feedback/integrations: get: operationId: getWpV2SitesbyWpcomSiteFeedbackIntegrations summary: GET /wp/v2/sites/{wpcom_site}/feedback/integrations tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: version in: query required: false schema: type: integer default: 1 /wp/v2/sites/{wpcom_site}/feedback/integrations-metadata: get: operationId: getWpV2SitesbyWpcomSiteFeedbackIntegrationsMetadata summary: GET /wp/v2/sites/{wpcom_site}/feedback/integrations-metadata tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wp/v2/sites/{wpcom_site}/feedback/integrations/{slug}: get: operationId: getWpV2SitesbyWpcomSiteFeedbackIntegrationsbySlug summary: GET /wp/v2/sites/{wpcom_site}/feedback/integrations/{slug} tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: slug in: path required: true schema: type: string delete: operationId: deleteWpV2SitesbyWpcomSiteFeedbackIntegrationsbySlug summary: DELETE /wp/v2/sites/{wpcom_site}/feedback/integrations/{slug} tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: slug in: path required: true schema: type: string /wp/v2/sites/{wpcom_site}/feedback/trash: delete: operationId: deleteWpV2SitesbyWpcomSiteFeedbackTrash summary: DELETE /wp/v2/sites/{wpcom_site}/feedback/trash tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: status in: query required: false schema: type: string enum: - trash - spam default: trash /wp/v2/sites/{wpcom_site}/feedback/{id}: get: operationId: getWpV2SitesbyWpcomSiteFeedbackbyId summary: GET /wp/v2/sites/{wpcom_site}/feedback/{id} tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteFeedbackbyId summary: POST /wp/v2/sites/{wpcom_site}/feedback/{id} tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - spam description: A named status for the post. comment_status: type: string enum: - open - closed description: Whether or not comments are open on the post. ping_status: type: string enum: - open - closed description: Whether or not the post can be pinged. put: operationId: putWpV2SitesbyWpcomSiteFeedbackbyId summary: PUT /wp/v2/sites/{wpcom_site}/feedback/{id} tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - spam description: A named status for the post. comment_status: type: string enum: - open - closed description: Whether or not comments are open on the post. ping_status: type: string enum: - open - closed description: Whether or not the post can be pinged. patch: operationId: patchWpV2SitesbyWpcomSiteFeedbackbyId summary: PATCH /wp/v2/sites/{wpcom_site}/feedback/{id} tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - spam description: A named status for the post. comment_status: type: string enum: - open - closed description: Whether or not comments are open on the post. ping_status: type: string enum: - open - closed description: Whether or not the post can be pinged. delete: operationId: deleteWpV2SitesbyWpcomSiteFeedbackbyId summary: DELETE /wp/v2/sites/{wpcom_site}/feedback/{id} tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. /wp/v2/sites/{wpcom_site}/feedback/{id}/autosaves: get: operationId: getWpV2SitesbyWpcomSiteFeedbackbyIdAutosaves summary: GET /wp/v2/sites/{wpcom_site}/feedback/{id}/autosaves tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteFeedbackbyIdAutosaves summary: POST /wp/v2/sites/{wpcom_site}/feedback/{id}/autosaves tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: parent: type: integer description: The ID for the parent of the autosave. date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - spam description: A named status for the post. comment_status: type: string enum: - open - closed description: Whether or not comments are open on the post. ping_status: type: string enum: - open - closed description: Whether or not the post can be pinged. /wp/v2/sites/{wpcom_site}/feedback/{id}/read: post: operationId: postWpV2SitesbyWpcomSiteFeedbackbyIdRead summary: POST /wp/v2/sites/{wpcom_site}/feedback/{id}/read tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: is_unread: type: boolean required: - is_unread /wp/v2/sites/{wpcom_site}/feedback/{parent}/autosaves/{id}: get: operationId: getWpV2SitesbyWpcomSiteFeedbackbyParentAutosavesbyId summary: GET /wp/v2/sites/{wpcom_site}/feedback/{parent}/autosaves/{id} tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. components: schemas: WPRestError: type: object description: WordPress REST API error envelope (observed on public-api.wordpress.com). properties: code: type: string example: rest_unauthorized message: type: string example: Authentication required. data: type: object properties: status: type: integer example: 401 securitySchemes: oauth2: type: oauth2 description: WordPress.com OAuth 2.1, per https://public-api.wordpress.com/.well-known/openid-configuration flows: authorizationCode: authorizationUrl: https://public-api.wordpress.com/oauth2-1/authorize tokenUrl: https://public-api.wordpress.com/oauth2-1/token refreshUrl: https://public-api.wordpress.com/oauth2-1/token scopes: global: '' auth: '' openid: '' profile: '' email: '' users: '' sites: '' posts: '' comments: '' taxonomy: '' follow: '' sharing: '' freshly-pressed: '' notifications: '' insights: '' read: '' stats: '' media: '' menus: '' batch: '' videos: '' bearerAuth: type: http scheme: bearer