# Derived by the API Evangelist enrichment pipeline from BXP's own WordPress REST # route-discovery document (https://www.bxp.com/wp-json/, HTTP 200, 2026-09-04). # Nothing in this file was invented: every path, method, parameter, default and enum # is a mechanical transform of that document. See openapi/boston-properties-wp-json-discovery.json # for the verbatim source. openapi: 3.1.0 info: title: BXP WordPress REST API (wp/v2) version: wp/v2 description: The WordPress REST API namespace `wp/v2` as served by BXP (Boston Properties) at https://www.bxp.com/wp-json/. BXP publishes no first-party developer documentation for this surface; it is the stock WordPress content API exposed by the corporate site (WP Engine hosted). Every path, method and parameter in this document was mechanically derived from BXP's own route-discovery document at https://www.bxp.com/wp-json/ (HTTP 200, 332 routes, fetched 2026-09-04). Nothing here was authored by hand. Anonymous reads were verified on /wp/v2/pages, /wp/v2/posts, /wp/v2/types, /wp/v2/categories, /wp/v2/search and /wp/v2/gl_js_maps; /wp/v2/settings returns 401 rest_forbidden. Write operations require authentication (WordPress application passwords or a cookie + X-WP-Nonce) and are not open to third parties. contact: name: BXP url: https://www.bxp.com/contact termsOfService: https://www.bxp.com/terms-of-service externalDocs: description: Upstream WordPress REST API handbook (not authored by BXP) url: https://developer.wordpress.org/rest-api/ servers: - url: https://www.bxp.com/wp-json description: BXP corporate site WordPress REST API tags: - name: block-directory - name: block-patterns - name: block-renderer - name: block-types - name: blocks - name: categories - name: comments - name: font-collections - name: font-families - name: gl_js_maps - name: global-styles - name: icons - name: index - name: media - name: menu-items - name: menu-locations - name: menus - name: navigation - name: pages - name: pattern-directory - name: plugins - name: posts - name: search - name: settings - name: sidebars - name: statuses - name: tags - name: taxonomies - name: template-parts - name: templates - name: themes - name: types - name: users - name: widget-types - name: widgets - name: wp_pattern_category paths: /wp/v2: get: operationId: getWpV2 summary: GET /wp/v2 tags: - index parameters: - name: context in: query required: false schema: default: view - name: namespace in: query required: false schema: default: wp/v2 responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/block-directory/search: get: operationId: getWpV2BlockDirectorySearch summary: GET /wp/v2/block-directory/search tags: - block-directory parameters: - name: context in: query required: false schema: type: string enum: - view 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 minimum: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 minimum: 1 maximum: 100 description: Maximum number of items to be returned in result set. - name: term in: query required: true schema: type: string description: Limit result set to blocks matching the search term. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/block-patterns/categories: get: operationId: getWpV2BlockPatternsCategories summary: GET /wp/v2/block-patterns/categories tags: - block-patterns responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/block-patterns/patterns: get: operationId: getWpV2BlockPatternsPatterns summary: GET /wp/v2/block-patterns/patterns tags: - block-patterns responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/block-renderer/{name}: parameters: - name: name in: path required: true schema: type: string get: operationId: getWpV2BlockRendererByName summary: GET /wp/v2/block-renderer/{name} tags: - block-renderer parameters: - name: attributes in: query required: false schema: type: object default: &id001 [] description: Attributes for the block. - name: context in: query required: false schema: type: string enum: &id002 - edit default: view description: Scope under which the request is made; determines fields present in response. - name: post_id in: query required: false schema: type: integer description: ID of the post context. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2BlockRendererByName summary: POST /wp/v2/block-renderer/{name} tags: - block-renderer requestBody: required: false content: application/json: schema: type: object properties: attributes: type: object default: *id001 description: Attributes for the block. context: type: string enum: *id002 default: view description: Scope under which the request is made; determines fields present in response. post_id: type: integer description: ID of the post context. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/block-types: get: operationId: getWpV2BlockTypes summary: GET /wp/v2/block-types tags: - block-types parameters: - 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: namespace in: query required: false schema: type: string description: Block namespace. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/block-types/{namespace}: parameters: - name: namespace in: path required: true schema: type: string get: operationId: getWpV2BlockTypesByNamespace summary: GET /wp/v2/block-types/{namespace} tags: - block-types parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/block-types/{namespace}/{name}: parameters: - name: namespace in: path required: true schema: type: string - name: name in: path required: true schema: type: string get: operationId: getWpV2BlockTypesByNamespaceByName summary: GET /wp/v2/block-types/{namespace}/{name} tags: - block-types parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/blocks: get: operationId: getWpV2Blocks summary: GET /wp/v2/blocks tags: - blocks parameters: - 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: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - 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: 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: 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: 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: 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: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 minimum: 1 maximum: 100 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: search_columns in: query required: false schema: type: array default: [] items: type: string enum: - post_title - post_content - post_excerpt description: Array of column names to be searched. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - 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 enum: - publish - future - draft - pending - private - trash - auto-draft - inherit - request-pending - request-confirmed - request-failed - request-completed - acf-disabled - email_sent - email_failed - email_scheduled - any description: Limit result set to posts assigned one or more statuses. - name: tax_relation in: query required: false schema: type: string enum: - AND - OR description: Limit result set based on relationship between multiple taxonomies. - name: wp_pattern_category in: query required: false schema: type: object description: Limit result set to items with specific terms assigned in the wp_pattern_category taxonomy. - name: wp_pattern_category_exclude in: query required: false schema: type: object description: Limit result set to items except those with specific terms assigned in the wp_pattern_category taxonomy. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2Blocks summary: POST /wp/v2/blocks tags: - blocks requestBody: required: false content: application/json: schema: type: object properties: content: type: object description: The content for the post. 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. excerpt: type: object description: The excerpt for the post. meta: type: object description: Meta fields. password: type: string description: A password to protect access to the content and excerpt. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. template: type: string description: The theme file to use to display the post. title: type: object description: The title for the post. wp_pattern_category: type: array items: type: integer description: The terms assigned to the post in the wp_pattern_category taxonomy. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/blocks/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2BlocksById summary: GET /wp/v2/blocks/{id} tags: - blocks parameters: - 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: excerpt_length in: query required: false schema: type: integer description: Override the default excerpt length. - name: password in: query required: false schema: type: string description: The password for the post if it is password protected. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2BlocksById summary: POST /wp/v2/blocks/{id} tags: - blocks requestBody: required: false content: application/json: schema: type: object properties: content: type: object description: The content for the post. 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. excerpt: type: object description: The excerpt for the post. meta: type: object description: Meta fields. password: type: string description: A password to protect access to the content and excerpt. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. template: type: string description: The theme file to use to display the post. title: type: object description: The title for the post. wp_pattern_category: type: array items: type: integer description: The terms assigned to the post in the wp_pattern_category taxonomy. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteWpV2BlocksById summary: DELETE /wp/v2/blocks/{id} tags: - blocks requestBody: required: false content: application/json: schema: type: object properties: force: type: boolean default: false description: Whether to bypass Trash and force deletion. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/blocks/{id}/autosaves: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2BlocksByIdAutosaves summary: GET /wp/v2/blocks/{id}/autosaves tags: - blocks parameters: - 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: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2BlocksByIdAutosaves summary: POST /wp/v2/blocks/{id}/autosaves tags: - blocks requestBody: required: false content: application/json: schema: type: object properties: content: type: object description: The content for the post. 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. excerpt: type: object description: The excerpt for the post. meta: type: object description: Meta fields. parent: type: integer description: The ID for the parent of the autosave. password: type: string description: A password to protect access to the content and excerpt. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. template: type: string description: The theme file to use to display the post. title: type: object description: The title for the post. wp_pattern_category: type: array items: type: integer description: The terms assigned to the post in the wp_pattern_category taxonomy. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/blocks/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2BlocksByParentAutosavesById summary: GET /wp/v2/blocks/{parent}/autosaves/{id} tags: - blocks parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/blocks/{parent}/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: getWpV2BlocksByParentRevisions summary: GET /wp/v2/blocks/{parent}/revisions tags: - blocks parameters: - 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: 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: 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: - date - id - include - relevance - slug - include_slugs - title default: date description: Sort collection by object attribute. - name: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer minimum: 1 maximum: 100 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/blocks/{parent}/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2BlocksByParentRevisionsById summary: GET /wp/v2/blocks/{parent}/revisions/{id} tags: - blocks parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2BlocksByParentRevisionsById summary: DELETE /wp/v2/blocks/{parent}/revisions/{id} tags: - blocks requestBody: required: false content: application/json: schema: type: object properties: force: type: boolean default: false description: Required to be true, as revisions do not support trashing. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/categories: get: operationId: getWpV2Categories summary: GET /wp/v2/categories tags: - categories parameters: - 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: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: hide_empty in: query required: false schema: type: boolean default: false description: Whether to hide terms not assigned to any posts. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: order in: query required: false schema: type: string enum: - asc - desc default: asc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name description: Sort collection by term attribute. - name: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - name: parent in: query required: false schema: type: integer description: Limit result set to terms assigned to a specific parent. - name: per_page in: query required: false schema: type: integer default: 10 minimum: 1 maximum: 100 description: Maximum number of items to be returned in result set. - name: post in: query required: false schema: type: integer description: Limit result set to terms assigned to a specific post. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to terms with one or more specific slugs. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2Categories summary: POST /wp/v2/categories tags: - categories requestBody: required: true content: application/json: schema: type: object properties: description: type: string description: HTML description of the term. meta: type: object description: Meta fields. name: type: string description: HTML title for the term. parent: type: integer description: The parent term ID. slug: type: string description: An alphanumeric identifier for the term unique to its type. required: - name responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/categories/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2CategoriesById summary: GET /wp/v2/categories/{id} tags: - categories parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2CategoriesById summary: POST /wp/v2/categories/{id} tags: - categories requestBody: required: false content: application/json: schema: type: object properties: description: type: string description: HTML description of the term. meta: type: object description: Meta fields. name: type: string description: HTML title for the term. parent: type: integer description: The parent term ID. slug: type: string description: An alphanumeric identifier for the term unique to its type. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteWpV2CategoriesById summary: DELETE /wp/v2/categories/{id} tags: - categories requestBody: required: false content: application/json: schema: type: object properties: force: type: boolean default: false description: Required to be true, as terms do not support trashing. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/comments: get: operationId: getWpV2Comments summary: GET /wp/v2/comments tags: - comments parameters: - name: after in: query required: false schema: type: string format: date-time description: Limit response to comments published after a given ISO8601 compliant date. - name: author in: query required: false schema: type: array items: type: integer description: Limit result set to comments assigned to specific user IDs. Requires authorization. - name: author_email in: query required: false schema: type: string format: email description: Limit result set to that from a specific author email. Requires authorization. - name: author_exclude in: query required: false schema: type: array items: type: integer description: Ensure result set excludes comments assigned to specific user IDs. Requires authorization. - name: before in: query required: false schema: type: string format: date-time description: Limit response to comments published before a given ISO8601 compliant date. - 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: 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: 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: - date - date_gmt - id - include - post - parent - type default: date_gmt description: Sort collection by comment attribute. - name: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - name: parent in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to comments of specific parent IDs. - name: parent_exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific parent IDs. - name: password in: query required: false schema: type: string description: The password for the post if it is password protected. - name: per_page in: query required: false schema: type: integer default: 10 minimum: 1 maximum: 100 description: Maximum number of items to be returned in result set. - name: post in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to comments assigned to specific post IDs. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: status in: query required: false schema: type: string default: approve description: Limit result set to comments assigned a specific status. Requires authorization. - name: type in: query required: false schema: type: string default: comment description: Limit result set to comments assigned a specific type. Requires authorization. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2Comments summary: POST /wp/v2/comments tags: - comments requestBody: required: false content: application/json: schema: type: object properties: author: type: integer description: The ID of the user object, if author was a user. author_email: type: string format: email description: Email address for the comment author. author_ip: type: string format: ip description: IP address for the comment author. author_name: type: string description: Display name for the comment author. author_url: type: string format: uri description: URL for the comment author. author_user_agent: type: string description: User agent for the comment author. content: type: object description: The content for the comment. date: type: string format: date-time description: The date the comment was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the comment was published, as GMT. meta: type: object description: Meta fields. parent: type: integer default: 0 description: The ID for the parent of the comment. post: type: integer default: 0 description: The ID of the associated post object. status: type: string description: State of the comment. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/comments/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2CommentsById summary: GET /wp/v2/comments/{id} tags: - comments parameters: - 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: password in: query required: false schema: type: string description: The password for the parent post of the comment (if the post is password protected). responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2CommentsById summary: POST /wp/v2/comments/{id} tags: - comments requestBody: required: false content: application/json: schema: type: object properties: author: type: integer description: The ID of the user object, if author was a user. author_email: type: string format: email description: Email address for the comment author. author_ip: type: string format: ip description: IP address for the comment author. author_name: type: string description: Display name for the comment author. author_url: type: string format: uri description: URL for the comment author. author_user_agent: type: string description: User agent for the comment author. content: type: object description: The content for the comment. date: type: string format: date-time description: The date the comment was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the comment was published, as GMT. meta: type: object description: Meta fields. parent: type: integer description: The ID for the parent of the comment. post: type: integer description: The ID of the associated post object. status: type: string description: State of the comment. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteWpV2CommentsById summary: DELETE /wp/v2/comments/{id} tags: - comments requestBody: required: false content: application/json: schema: type: object properties: force: type: boolean default: false description: Whether to bypass Trash and force deletion. password: type: string description: The password for the parent post of the comment (if the post is password protected). responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/font-collections: get: operationId: getWpV2FontCollections summary: GET /wp/v2/font-collections tags: - font-collections parameters: - 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 minimum: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 minimum: 1 maximum: 100 description: Maximum number of items to be returned in result set. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/font-collections/{slug}: parameters: - name: slug in: path required: true schema: type: string get: operationId: getWpV2FontCollectionsBySlug summary: GET /wp/v2/font-collections/{slug} tags: - font-collections parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/font-families: get: operationId: getWpV2FontFamilies summary: GET /wp/v2/font-families tags: - font-families parameters: - 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: 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: 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: - id - include default: id description: Sort collection by post attribute. - name: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 minimum: 1 maximum: 100 description: Maximum number of items to be returned in result set. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2FontFamilies summary: POST /wp/v2/font-families tags: - font-families requestBody: required: true content: application/json: schema: type: object properties: font_family_settings: type: string description: font-family declaration in theme.json format, encoded as a string. theme_json_version: type: integer default: 3 minimum: 2 maximum: 3 description: Version of the theme.json schema used for the typography settings. required: - font_family_settings responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/font-families/{font_family_id}/font-faces: parameters: - name: font_family_id in: path required: true schema: type: string get: operationId: getWpV2FontFamiliesByFontFamilyIdFontFaces summary: GET /wp/v2/font-families/{font_family_id}/font-faces tags: - font-families parameters: - 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: 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: 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: - id - include default: id description: Sort collection by post attribute. - name: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 minimum: 1 maximum: 100 description: Maximum number of items to be returned in result set. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2FontFamiliesByFontFamilyIdFontFaces summary: POST /wp/v2/font-families/{font_family_id}/font-faces tags: - font-families requestBody: required: true content: application/json: schema: type: object properties: font_face_settings: type: string description: font-face declaration in theme.json format, encoded as a string. theme_json_version: type: integer default: 3 minimum: 2 maximum: 3 description: Version of the theme.json schema used for the typography settings. required: - font_face_settings responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/font-families/{font_family_id}/font-faces/{id}: parameters: - name: font_family_id in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2FontFamiliesByFontFamilyIdFontFacesById summary: GET /wp/v2/font-families/{font_family_id}/font-faces/{id} tags: - font-families parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2FontFamiliesByFontFamilyIdFontFacesById summary: DELETE /wp/v2/font-families/{font_family_id}/font-faces/{id} tags: - font-families requestBody: required: false content: application/json: schema: type: object properties: force: type: boolean default: false description: Whether to bypass Trash and force deletion. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/font-families/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2FontFamiliesById summary: GET /wp/v2/font-families/{id} tags: - font-families parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2FontFamiliesById summary: POST /wp/v2/font-families/{id} tags: - font-families requestBody: required: true content: application/json: schema: type: object properties: font_family_settings: type: string description: font-family declaration in theme.json format, encoded as a string. theme_json_version: type: integer default: 3 minimum: 2 maximum: 3 description: Version of the theme.json schema used for the typography settings. required: - font_family_settings responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteWpV2FontFamiliesById summary: DELETE /wp/v2/font-families/{id} tags: - font-families requestBody: required: false content: application/json: schema: type: object properties: force: type: boolean default: false description: Whether to bypass Trash and force deletion. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/gl_js_maps: get: operationId: getWpV2GlJsMaps summary: GET /wp/v2/gl_js_maps tags: - gl_js_maps parameters: - 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: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - 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: 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: 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: 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: 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: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 minimum: 1 maximum: 100 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: search_columns in: query required: false schema: type: array default: [] items: type: string enum: - post_title - post_content - post_excerpt description: Array of column names to be searched. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - 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 enum: - publish - future - draft - pending - private - trash - auto-draft - inherit - request-pending - request-confirmed - request-failed - request-completed - acf-disabled - email_sent - email_failed - email_scheduled - any description: Limit result set to posts assigned one or more statuses. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2GlJsMaps summary: POST /wp/v2/gl_js_maps tags: - gl_js_maps requestBody: required: false content: application/json: schema: type: object properties: content: type: object description: The content for the post. 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. excerpt: type: object description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. meta: type: object description: Meta fields. password: type: string description: A password to protect access to the content and excerpt. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. template: type: string description: The theme file to use to display the post. title: type: object description: The title for the post. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/gl_js_maps/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2GlJsMapsById summary: GET /wp/v2/gl_js_maps/{id} tags: - gl_js_maps parameters: - 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: excerpt_length in: query required: false schema: type: integer description: Override the default excerpt length. - name: password in: query required: false schema: type: string description: The password for the post if it is password protected. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2GlJsMapsById summary: POST /wp/v2/gl_js_maps/{id} tags: - gl_js_maps requestBody: required: false content: application/json: schema: type: object properties: content: type: object description: The content for the post. 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. excerpt: type: object description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. meta: type: object description: Meta fields. password: type: string description: A password to protect access to the content and excerpt. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. template: type: string description: The theme file to use to display the post. title: type: object description: The title for the post. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteWpV2GlJsMapsById summary: DELETE /wp/v2/gl_js_maps/{id} tags: - gl_js_maps requestBody: required: false content: application/json: schema: type: object properties: force: type: boolean default: false description: Whether to bypass Trash and force deletion. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/gl_js_maps/{id}/autosaves: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2GlJsMapsByIdAutosaves summary: GET /wp/v2/gl_js_maps/{id}/autosaves tags: - gl_js_maps parameters: - 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: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2GlJsMapsByIdAutosaves summary: POST /wp/v2/gl_js_maps/{id}/autosaves tags: - gl_js_maps requestBody: required: false content: application/json: schema: type: object properties: content: type: object description: The content for the post. 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. excerpt: type: object description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. meta: type: object description: Meta fields. parent: type: integer description: The ID for the parent of the autosave. password: type: string description: A password to protect access to the content and excerpt. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. template: type: string description: The theme file to use to display the post. title: type: object description: The title for the post. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/gl_js_maps/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2GlJsMapsByParentAutosavesById summary: GET /wp/v2/gl_js_maps/{parent}/autosaves/{id} tags: - gl_js_maps parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/gl_js_maps/{parent}/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: getWpV2GlJsMapsByParentRevisions summary: GET /wp/v2/gl_js_maps/{parent}/revisions tags: - gl_js_maps parameters: - 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: 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: 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: - date - id - include - relevance - slug - include_slugs - title default: date description: Sort collection by object attribute. - name: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer minimum: 1 maximum: 100 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/gl_js_maps/{parent}/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2GlJsMapsByParentRevisionsById summary: GET /wp/v2/gl_js_maps/{parent}/revisions/{id} tags: - gl_js_maps parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2GlJsMapsByParentRevisionsById summary: DELETE /wp/v2/gl_js_maps/{parent}/revisions/{id} tags: - gl_js_maps requestBody: required: false content: application/json: schema: type: object properties: force: type: boolean default: false description: Required to be true, as revisions do not support trashing. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/global-styles/themes/{stylesheet}: parameters: - name: stylesheet in: path required: true schema: type: string get: operationId: getWpV2GlobalStylesThemesByStylesheet summary: GET /wp/v2/global-styles/themes/{stylesheet} tags: - global-styles responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/global-styles/themes/{stylesheet}/variations: parameters: - name: stylesheet in: path required: true schema: type: string get: operationId: getWpV2GlobalStylesThemesByStylesheetVariations summary: GET /wp/v2/global-styles/themes/{stylesheet}/variations tags: - global-styles responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/global-styles/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2GlobalStylesById summary: GET /wp/v2/global-styles/{id} tags: - global-styles responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2GlobalStylesById summary: POST /wp/v2/global-styles/{id} tags: - global-styles requestBody: required: false content: application/json: schema: type: object properties: settings: type: object description: Global settings. styles: type: object description: Global styles. title: type: object description: Title of the global styles variation. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/global-styles/{parent}/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: getWpV2GlobalStylesByParentRevisions summary: GET /wp/v2/global-styles/{parent}/revisions tags: - global-styles parameters: - 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: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer minimum: 1 maximum: 100 description: Maximum number of items to be returned in result set. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/global-styles/{parent}/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2GlobalStylesByParentRevisionsById summary: GET /wp/v2/global-styles/{parent}/revisions/{id} tags: - global-styles parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/icons: get: operationId: getWpV2Icons summary: GET /wp/v2/icons tags: - icons parameters: - 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 minimum: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 minimum: 1 maximum: 100 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/icons/{name}: parameters: - name: name in: path required: true schema: type: string get: operationId: getWpV2IconsByName summary: GET /wp/v2/icons/{name} tags: - icons parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/media: get: operationId: getWpV2Media summary: GET /wp/v2/media tags: - media parameters: - 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: author in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to posts assigned to specific authors. - name: author_exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes posts assigned to specific authors. - 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: 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: 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: media_type in: query required: false schema: type: array items: type: string enum: - image - video - text - application - audio description: Limit result set to attachments of a particular media type or media types. - name: mime_type in: query required: false schema: type: array items: type: string description: Limit result set to attachments of a particular MIME type or MIME types. - 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: 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: 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: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - 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: per_page in: query required: false schema: type: integer default: 10 minimum: 1 maximum: 100 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: search_columns in: query required: false schema: type: array default: [] items: type: string enum: - post_title - post_content - post_excerpt description: Array of column names to be searched. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - 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: inherit items: type: string enum: - inherit - private - trash description: Limit result set to posts assigned one or more statuses. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2Media summary: POST /wp/v2/media tags: - media requestBody: required: false content: application/json: schema: type: object properties: alt_text: type: string description: Alternative text to display when attachment is not displayed. author: type: integer description: The ID for the author of the post. caption: type: object description: The attachment caption. comment_status: type: string enum: - open - closed description: Whether or not comments are open on the post. 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. description: type: object description: The attachment description. featured_media: type: integer description: The ID of the featured media for the post. meta: type: object description: Meta fields. ping_status: type: string enum: - open - closed description: Whether or not the post can be pinged. post: type: integer description: The ID for the associated post of the attachment. slug: type: string description: An alphanumeric identifier for the post unique to its type. smush: type: string description: Smush data. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. template: type: string description: The theme file to use to display the post. title: type: object description: The title for the post. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/media/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2MediaById summary: GET /wp/v2/media/{id} tags: - media parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2MediaById summary: POST /wp/v2/media/{id} tags: - media requestBody: required: false content: application/json: schema: type: object properties: alt_text: type: string description: Alternative text to display when attachment is not displayed. author: type: integer description: The ID for the author of the post. caption: type: object description: The attachment caption. comment_status: type: string enum: - open - closed description: Whether or not comments are open on the post. 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. description: type: object description: The attachment description. featured_media: type: integer description: The ID of the featured media for the post. meta: type: object description: Meta fields. ping_status: type: string enum: - open - closed description: Whether or not the post can be pinged. post: type: integer description: The ID for the associated post of the attachment. slug: type: string description: An alphanumeric identifier for the post unique to its type. smush: type: string description: Smush data. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. template: type: string description: The theme file to use to display the post. title: type: object description: The title for the post. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteWpV2MediaById summary: DELETE /wp/v2/media/{id} tags: - media requestBody: required: false content: application/json: schema: type: object properties: force: type: boolean default: false description: Whether to bypass Trash and force deletion. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/media/{id}/edit: parameters: - name: id in: path required: true schema: type: string post: operationId: createWpV2MediaByIdEdit summary: POST /wp/v2/media/{id}/edit tags: - media requestBody: required: true content: application/json: schema: type: object properties: alt_text: type: string description: Alternative text to display when attachment is not displayed. caption: type: object description: The attachment caption. description: type: object description: The attachment description. height: type: number minimum: 0 maximum: 100 description: 'As a percentage of the image, the height to crop the image to. DEPRECATED: Use `modifiers` instead.' modifiers: type: array items: type: object description: Array of image edits. post: type: integer description: The ID for the associated post of the attachment. rotation: type: integer minimum: 0 maximum: 360 description: 'The amount to rotate the image clockwise in degrees. DEPRECATED: Use `modifiers` instead.' src: type: string format: uri description: URL to the edited image file. title: type: object description: The title for the post. width: type: number minimum: 0 maximum: 100 description: 'As a percentage of the image, the width to crop the image to. DEPRECATED: Use `modifiers` instead.' x: type: number minimum: 0 maximum: 100 description: 'As a percentage of the image, the x position to start the crop from. DEPRECATED: Use `modifiers` instead.' y: type: number minimum: 0 maximum: 100 description: 'As a percentage of the image, the y position to start the crop from. DEPRECATED: Use `modifiers` instead.' required: - src responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/media/{id}/post-process: parameters: - name: id in: path required: true schema: type: string post: operationId: createWpV2MediaByIdPostProcess summary: POST /wp/v2/media/{id}/post-process tags: - media requestBody: required: true content: application/json: schema: type: object properties: action: type: string enum: - create-image-subsizes required: - action responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/menu-items: get: operationId: getWpV2MenuItems summary: GET /wp/v2/menu-items tags: - menu-items parameters: - 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: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - 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: 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: menu_order in: query required: false schema: type: integer description: Limit result set to posts with a specific menu_order value. - name: menus in: query required: false schema: type: object description: Limit result set to items with specific terms assigned in the menus taxonomy. - name: menus_exclude in: query required: false schema: type: object description: Limit result set to items except those with specific terms assigned in the menus taxonomy. - 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: 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: 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: asc 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 - menu_order default: menu_order description: Sort collection by object attribute. - name: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 100 minimum: 1 maximum: 100 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: search_columns in: query required: false schema: type: array default: [] items: type: string enum: - post_title - post_content - post_excerpt description: Array of column names to be searched. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - 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 enum: - publish - future - draft - pending - private - trash - auto-draft - inherit - request-pending - request-confirmed - request-failed - request-completed - acf-disabled - email_sent - email_failed - email_scheduled - any description: Limit result set to posts assigned one or more statuses. - name: tax_relation in: query required: false schema: type: string enum: - AND - OR description: Limit result set based on relationship between multiple taxonomies. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2MenuItems summary: POST /wp/v2/menu-items tags: - menu-items requestBody: required: false content: application/json: schema: type: object properties: attr_title: type: string description: Text for the title attribute of the link element for this menu item. classes: type: array items: type: string description: Class names for the link element of this menu item. description: type: string description: The description of this menu item. menu_order: type: integer default: 1 minimum: 1 description: The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0. menus: type: integer description: The terms assigned to the object in the nav_menu taxonomy. meta: type: object description: Meta fields. object: type: string description: The type of object originally represented, such as "category", "post", or "attachment". object_id: type: integer default: 0 minimum: 0 description: The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories. parent: type: integer default: 0 minimum: 0 description: The ID for the parent of the object. status: type: string enum: - publish - future - draft - pending - private - acf-disabled default: publish description: A named status for the object. target: type: string enum: - _blank - '' description: The target attribute of the link element for this menu item. title: type: string description: The title for the object. type: type: string enum: - taxonomy - post_type - post_type_archive - custom default: custom description: The family of objects originally represented, such as "post_type" or "taxonomy". url: type: string format: uri description: The URL to which this menu item points. xfn: type: array items: type: string description: The XFN relationship expressed in the link of this menu item. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/menu-items/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2MenuItemsById summary: GET /wp/v2/menu-items/{id} tags: - menu-items parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2MenuItemsById summary: POST /wp/v2/menu-items/{id} tags: - menu-items requestBody: required: false content: application/json: schema: type: object properties: attr_title: type: string description: Text for the title attribute of the link element for this menu item. classes: type: array items: type: string description: Class names for the link element of this menu item. description: type: string description: The description of this menu item. menu_order: type: integer minimum: 1 description: The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0. menus: type: integer description: The terms assigned to the object in the nav_menu taxonomy. meta: type: object description: Meta fields. object: type: string description: The type of object originally represented, such as "category", "post", or "attachment". object_id: type: integer minimum: 0 description: The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories. parent: type: integer minimum: 0 description: The ID for the parent of the object. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the object. target: type: string enum: - _blank - '' description: The target attribute of the link element for this menu item. title: type: string description: The title for the object. type: type: string enum: - taxonomy - post_type - post_type_archive - custom description: The family of objects originally represented, such as "post_type" or "taxonomy". url: type: string format: uri description: The URL to which this menu item points. xfn: type: array items: type: string description: The XFN relationship expressed in the link of this menu item. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteWpV2MenuItemsById summary: DELETE /wp/v2/menu-items/{id} tags: - menu-items requestBody: required: false content: application/json: schema: type: object properties: force: type: boolean default: false description: Whether to bypass Trash and force deletion. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/menu-items/{id}/autosaves: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2MenuItemsByIdAutosaves summary: GET /wp/v2/menu-items/{id}/autosaves tags: - menu-items parameters: - 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: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2MenuItemsByIdAutosaves summary: POST /wp/v2/menu-items/{id}/autosaves tags: - menu-items requestBody: required: false content: application/json: schema: type: object properties: attr_title: type: string description: Text for the title attribute of the link element for this menu item. classes: type: array items: type: string description: Class names for the link element of this menu item. description: type: string description: The description of this menu item. menu_order: type: integer minimum: 1 description: The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0. menus: type: integer description: The terms assigned to the object in the nav_menu taxonomy. meta: type: object description: Meta fields. object: type: string description: The type of object originally represented, such as "category", "post", or "attachment". object_id: type: integer minimum: 0 description: The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories. parent: type: integer minimum: 0 description: The ID for the parent of the object. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the object. target: type: string enum: - _blank - '' description: The target attribute of the link element for this menu item. title: type: string description: The title for the object. type: type: string enum: - taxonomy - post_type - post_type_archive - custom description: The family of objects originally represented, such as "post_type" or "taxonomy". url: type: string format: uri description: The URL to which this menu item points. xfn: type: array items: type: string description: The XFN relationship expressed in the link of this menu item. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/menu-items/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2MenuItemsByParentAutosavesById summary: GET /wp/v2/menu-items/{parent}/autosaves/{id} tags: - menu-items parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/menu-locations: get: operationId: getWpV2MenuLocations summary: GET /wp/v2/menu-locations tags: - menu-locations parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/menu-locations/{location}: parameters: - name: location in: path required: true schema: type: string get: operationId: getWpV2MenuLocationsByLocation summary: GET /wp/v2/menu-locations/{location} tags: - menu-locations parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/menus: get: operationId: getWpV2Menus summary: GET /wp/v2/menus tags: - menus parameters: - 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: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: hide_empty in: query required: false schema: type: boolean default: false description: Whether to hide terms not assigned to any posts. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - 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: asc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name description: Sort collection by term attribute. - name: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 minimum: 1 maximum: 100 description: Maximum number of items to be returned in result set. - name: post in: query required: false schema: type: integer description: Limit result set to terms assigned to a specific post. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to terms with one or more specific slugs. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2Menus summary: POST /wp/v2/menus tags: - menus requestBody: required: true content: application/json: schema: type: object properties: auto_add: type: boolean description: Whether to automatically add top level pages to this menu. description: type: string description: HTML description of the term. locations: type: array items: type: string description: The locations assigned to the menu. meta: type: object description: Meta fields. name: type: string description: HTML title for the term. slug: type: string description: An alphanumeric identifier for the term unique to its type. required: - name responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/menus/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2MenusById summary: GET /wp/v2/menus/{id} tags: - menus parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2MenusById summary: POST /wp/v2/menus/{id} tags: - menus requestBody: required: false content: application/json: schema: type: object properties: auto_add: type: boolean description: Whether to automatically add top level pages to this menu. description: type: string description: HTML description of the term. locations: type: array items: type: string description: The locations assigned to the menu. meta: type: object description: Meta fields. name: type: string description: HTML title for the term. slug: type: string description: An alphanumeric identifier for the term unique to its type. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteWpV2MenusById summary: DELETE /wp/v2/menus/{id} tags: - menus requestBody: required: false content: application/json: schema: type: object properties: force: type: boolean default: false description: Required to be true, as terms do not support trashing. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/navigation: get: operationId: getWpV2Navigation summary: GET /wp/v2/navigation tags: - navigation parameters: - 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: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - 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: 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: 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: 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: 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: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 minimum: 1 maximum: 100 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: search_columns in: query required: false schema: type: array default: [] items: type: string enum: - post_title - post_content - post_excerpt description: Array of column names to be searched. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - 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 enum: - publish - future - draft - pending - private - trash - auto-draft - inherit - request-pending - request-confirmed - request-failed - request-completed - acf-disabled - email_sent - email_failed - email_scheduled - any description: Limit result set to posts assigned one or more statuses. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2Navigation summary: POST /wp/v2/navigation tags: - navigation requestBody: required: false content: application/json: schema: type: object properties: content: type: object description: The content for the post. 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. password: type: string description: A password to protect access to the content and excerpt. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. template: type: string description: The theme file to use to display the post. title: type: object description: The title for the post. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/navigation/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2NavigationById summary: GET /wp/v2/navigation/{id} tags: - navigation parameters: - 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: password in: query required: false schema: type: string description: The password for the post if it is password protected. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2NavigationById summary: POST /wp/v2/navigation/{id} tags: - navigation requestBody: required: false content: application/json: schema: type: object properties: content: type: object description: The content for the post. 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. password: type: string description: A password to protect access to the content and excerpt. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. template: type: string description: The theme file to use to display the post. title: type: object description: The title for the post. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteWpV2NavigationById summary: DELETE /wp/v2/navigation/{id} tags: - navigation requestBody: required: false content: application/json: schema: type: object properties: force: type: boolean default: false description: Whether to bypass Trash and force deletion. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/navigation/{id}/autosaves: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2NavigationByIdAutosaves summary: GET /wp/v2/navigation/{id}/autosaves tags: - navigation parameters: - 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: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2NavigationByIdAutosaves summary: POST /wp/v2/navigation/{id}/autosaves tags: - navigation requestBody: required: false content: application/json: schema: type: object properties: content: type: object description: The content for the post. 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. parent: type: integer description: The ID for the parent of the autosave. password: type: string description: A password to protect access to the content and excerpt. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. template: type: string description: The theme file to use to display the post. title: type: object description: The title for the post. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/navigation/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2NavigationByParentAutosavesById summary: GET /wp/v2/navigation/{parent}/autosaves/{id} tags: - navigation parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/navigation/{parent}/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: getWpV2NavigationByParentRevisions summary: GET /wp/v2/navigation/{parent}/revisions tags: - navigation parameters: - 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: 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: 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: - date - id - include - relevance - slug - include_slugs - title default: date description: Sort collection by object attribute. - name: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer minimum: 1 maximum: 100 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/navigation/{parent}/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2NavigationByParentRevisionsById summary: GET /wp/v2/navigation/{parent}/revisions/{id} tags: - navigation parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2NavigationByParentRevisionsById summary: DELETE /wp/v2/navigation/{parent}/revisions/{id} tags: - navigation requestBody: required: false content: application/json: schema: type: object properties: force: type: boolean default: false description: Required to be true, as revisions do not support trashing. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/pages: get: operationId: getWpV2Pages summary: GET /wp/v2/pages tags: - pages parameters: - 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: author in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to posts assigned to specific authors. - name: author_exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes posts assigned to specific authors. - 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: 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: 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: menu_order in: query required: false schema: type: integer description: Limit result set to posts with a specific menu_order value. - 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: 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: 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 - menu_order default: date description: Sort collection by post attribute. - name: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - 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: per_page in: query required: false schema: type: integer default: 10 minimum: 1 maximum: 100 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: search_columns in: query required: false schema: type: array default: [] items: type: string enum: - post_title - post_content - post_excerpt description: Array of column names to be searched. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - 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 enum: - publish - future - draft - pending - private - trash - auto-draft - inherit - request-pending - request-confirmed - request-failed - request-completed - acf-disabled - email_sent - email_failed - email_scheduled - any description: Limit result set to posts assigned one or more statuses. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2Pages summary: POST /wp/v2/pages tags: - pages requestBody: required: false content: application/json: schema: type: object properties: author: type: integer description: The ID for the author of the post. comment_status: type: string enum: - open - closed description: Whether or not comments are open on the post. content: type: object description: The content for the post. 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. excerpt: type: object description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. menu_order: type: integer description: The order of the post in relation to other posts. meta: type: object description: Meta fields. parent: type: integer description: The ID for the parent of the post. password: type: string description: A password to protect access to the content and excerpt. ping_status: type: string enum: - open - closed description: Whether or not the post can be pinged. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. template: type: string description: The theme file to use to display the post. title: type: object description: The title for the post. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/pages/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2PagesById summary: GET /wp/v2/pages/{id} tags: - pages parameters: - 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: excerpt_length in: query required: false schema: type: integer description: Override the default excerpt length. - name: password in: query required: false schema: type: string description: The password for the post if it is password protected. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2PagesById summary: POST /wp/v2/pages/{id} tags: - pages requestBody: required: false content: application/json: schema: type: object properties: author: type: integer description: The ID for the author of the post. comment_status: type: string enum: - open - closed description: Whether or not comments are open on the post. content: type: object description: The content for the post. 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. excerpt: type: object description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. menu_order: type: integer description: The order of the post in relation to other posts. meta: type: object description: Meta fields. parent: type: integer description: The ID for the parent of the post. password: type: string description: A password to protect access to the content and excerpt. ping_status: type: string enum: - open - closed description: Whether or not the post can be pinged. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. template: type: string description: The theme file to use to display the post. title: type: object description: The title for the post. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteWpV2PagesById summary: DELETE /wp/v2/pages/{id} tags: - pages requestBody: required: false content: application/json: schema: type: object properties: force: type: boolean default: false description: Whether to bypass Trash and force deletion. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/pages/{id}/autosaves: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2PagesByIdAutosaves summary: GET /wp/v2/pages/{id}/autosaves tags: - pages parameters: - 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: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2PagesByIdAutosaves summary: POST /wp/v2/pages/{id}/autosaves tags: - pages requestBody: required: false content: application/json: schema: type: object properties: author: type: integer description: The ID for the author of the post. comment_status: type: string enum: - open - closed description: Whether or not comments are open on the post. content: type: object description: The content for the post. 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. excerpt: type: object description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. menu_order: type: integer description: The order of the post in relation to other posts. meta: type: object description: Meta fields. parent: type: integer description: The ID for the parent of the post. password: type: string description: A password to protect access to the content and excerpt. ping_status: type: string enum: - open - closed description: Whether or not the post can be pinged. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. template: type: string description: The theme file to use to display the post. title: type: object description: The title for the post. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/pages/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2PagesByParentAutosavesById summary: GET /wp/v2/pages/{parent}/autosaves/{id} tags: - pages parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/pages/{parent}/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: getWpV2PagesByParentRevisions summary: GET /wp/v2/pages/{parent}/revisions tags: - pages parameters: - 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: 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: 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: - date - id - include - relevance - slug - include_slugs - title default: date description: Sort collection by object attribute. - name: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer minimum: 1 maximum: 100 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/pages/{parent}/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2PagesByParentRevisionsById summary: GET /wp/v2/pages/{parent}/revisions/{id} tags: - pages parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2PagesByParentRevisionsById summary: DELETE /wp/v2/pages/{parent}/revisions/{id} tags: - pages requestBody: required: false content: application/json: schema: type: object properties: force: type: boolean default: false description: Required to be true, as revisions do not support trashing. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/pattern-directory/patterns: get: operationId: getWpV2PatternDirectoryPatterns summary: GET /wp/v2/pattern-directory/patterns tags: - pattern-directory parameters: - name: category in: query required: false schema: type: integer minimum: 1 description: Limit results to those matching a category ID. - 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: keyword in: query required: false schema: type: integer minimum: 1 description: Limit results to those matching a keyword ID. - 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 - favorite_count default: date description: Sort collection by post attribute. - name: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 100 minimum: 1 maximum: 100 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: slug in: query required: false schema: type: array items: type: string description: Limit results to those matching a pattern (slug). responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/plugins: get: operationId: getWpV2Plugins summary: GET /wp/v2/plugins tags: - plugins parameters: - 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: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: status in: query required: false schema: type: array items: type: string enum: - inactive - active description: Limits results to plugins with the given status. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2Plugins summary: POST /wp/v2/plugins tags: - plugins requestBody: required: true content: application/json: schema: type: object properties: slug: type: string description: WordPress.org plugin directory slug. status: type: string enum: - inactive - active default: inactive description: The plugin activation status. required: - slug responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/plugins/{plugin}: parameters: - name: plugin in: path required: true schema: type: string get: operationId: getWpV2PluginsByPlugin summary: GET /wp/v2/plugins/{plugin} tags: - plugins parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2PluginsByPlugin summary: POST /wp/v2/plugins/{plugin} tags: - plugins requestBody: required: false content: application/json: schema: type: object properties: context: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. status: type: string enum: - inactive - active description: The plugin activation status. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteWpV2PluginsByPlugin summary: DELETE /wp/v2/plugins/{plugin} tags: - plugins requestBody: required: false content: application/json: schema: type: object properties: context: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/posts: get: operationId: getWpV2Posts summary: GET /wp/v2/posts tags: - posts parameters: - 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: author in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to posts assigned to specific authors. - name: author_exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes posts assigned to specific authors. - 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: categories in: query required: false schema: type: object description: Limit result set to items with specific terms assigned in the categories taxonomy. - name: categories_exclude in: query required: false schema: type: object description: Limit result set to items except those with specific terms assigned in the categories taxonomy. - 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: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: format in: query required: false schema: type: array items: type: string enum: - standard - aside - chat - gallery - link - image - quote - status - video - audio description: Limit result set to items assigned one or more given formats. - name: ignore_sticky in: query required: false schema: type: boolean default: true description: Whether to ignore sticky posts or not. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - 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: 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: 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: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 minimum: 1 maximum: 100 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: search_columns in: query required: false schema: type: array default: [] items: type: string enum: - post_title - post_content - post_excerpt description: Array of column names to be searched. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - 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 enum: - publish - future - draft - pending - private - trash - auto-draft - inherit - request-pending - request-confirmed - request-failed - request-completed - acf-disabled - email_sent - email_failed - email_scheduled - any description: Limit result set to posts assigned one or more statuses. - name: sticky in: query required: false schema: type: boolean description: Limit result set to items that are sticky. - name: tags in: query required: false schema: type: object description: Limit result set to items with specific terms assigned in the tags taxonomy. - name: tags_exclude in: query required: false schema: type: object description: Limit result set to items except those with specific terms assigned in the tags taxonomy. - name: tax_relation in: query required: false schema: type: string enum: - AND - OR description: Limit result set based on relationship between multiple taxonomies. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2Posts summary: POST /wp/v2/posts tags: - posts requestBody: required: false content: application/json: schema: type: object properties: author: type: integer description: The ID for the author of the post. categories: type: array items: type: integer description: The terms assigned to the post in the category taxonomy. comment_status: type: string enum: - open - closed description: Whether or not comments are open on the post. content: type: object description: The content for the post. 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. excerpt: type: object description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. format: type: string enum: - standard - aside - chat - gallery - link - image - quote - status - video - audio description: The format for the post. meta: type: object description: Meta fields. password: type: string description: A password to protect access to the content and excerpt. ping_status: type: string enum: - open - closed description: Whether or not the post can be pinged. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. sticky: type: boolean description: Whether or not the post should be treated as sticky. tags: type: array items: type: integer description: The terms assigned to the post in the post_tag taxonomy. template: type: string description: The theme file to use to display the post. title: type: object description: The title for the post. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/posts/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2PostsById summary: GET /wp/v2/posts/{id} tags: - posts parameters: - 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: excerpt_length in: query required: false schema: type: integer description: Override the default excerpt length. - name: password in: query required: false schema: type: string description: The password for the post if it is password protected. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2PostsById summary: POST /wp/v2/posts/{id} tags: - posts requestBody: required: false content: application/json: schema: type: object properties: author: type: integer description: The ID for the author of the post. categories: type: array items: type: integer description: The terms assigned to the post in the category taxonomy. comment_status: type: string enum: - open - closed description: Whether or not comments are open on the post. content: type: object description: The content for the post. 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. excerpt: type: object description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. format: type: string enum: - standard - aside - chat - gallery - link - image - quote - status - video - audio description: The format for the post. meta: type: object description: Meta fields. password: type: string description: A password to protect access to the content and excerpt. ping_status: type: string enum: - open - closed description: Whether or not the post can be pinged. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. sticky: type: boolean description: Whether or not the post should be treated as sticky. tags: type: array items: type: integer description: The terms assigned to the post in the post_tag taxonomy. template: type: string description: The theme file to use to display the post. title: type: object description: The title for the post. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteWpV2PostsById summary: DELETE /wp/v2/posts/{id} tags: - posts requestBody: required: false content: application/json: schema: type: object properties: force: type: boolean default: false description: Whether to bypass Trash and force deletion. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/posts/{id}/autosaves: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2PostsByIdAutosaves summary: GET /wp/v2/posts/{id}/autosaves tags: - posts parameters: - 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: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2PostsByIdAutosaves summary: POST /wp/v2/posts/{id}/autosaves tags: - posts requestBody: required: false content: application/json: schema: type: object properties: author: type: integer description: The ID for the author of the post. categories: type: array items: type: integer description: The terms assigned to the post in the category taxonomy. comment_status: type: string enum: - open - closed description: Whether or not comments are open on the post. content: type: object description: The content for the post. 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. excerpt: type: object description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. format: type: string enum: - standard - aside - chat - gallery - link - image - quote - status - video - audio description: The format for the post. meta: type: object description: Meta fields. parent: type: integer description: The ID for the parent of the autosave. password: type: string description: A password to protect access to the content and excerpt. ping_status: type: string enum: - open - closed description: Whether or not the post can be pinged. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. sticky: type: boolean description: Whether or not the post should be treated as sticky. tags: type: array items: type: integer description: The terms assigned to the post in the post_tag taxonomy. template: type: string description: The theme file to use to display the post. title: type: object description: The title for the post. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/posts/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2PostsByParentAutosavesById summary: GET /wp/v2/posts/{parent}/autosaves/{id} tags: - posts parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/posts/{parent}/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: getWpV2PostsByParentRevisions summary: GET /wp/v2/posts/{parent}/revisions tags: - posts parameters: - 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: 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: 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: - date - id - include - relevance - slug - include_slugs - title default: date description: Sort collection by object attribute. - name: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer minimum: 1 maximum: 100 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/posts/{parent}/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2PostsByParentRevisionsById summary: GET /wp/v2/posts/{parent}/revisions/{id} tags: - posts parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2PostsByParentRevisionsById summary: DELETE /wp/v2/posts/{parent}/revisions/{id} tags: - posts requestBody: required: false content: application/json: schema: type: object properties: force: type: boolean default: false description: Required to be true, as revisions do not support trashing. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/search: get: operationId: getWpV2Search summary: GET /wp/v2/search tags: - search parameters: - name: context in: query required: false schema: type: string enum: - view - embed default: view description: Scope under which the request is made; determines fields present in response. - 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: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 minimum: 1 maximum: 100 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: subtype in: query required: false schema: type: array default: any items: type: string enum: - post - page - gl_js_maps - category - post_tag - any description: Limit results to items of one or more object subtypes. - name: type in: query required: false schema: type: string enum: - post - term - post-format default: post description: Limit results to items of an object type. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/settings: get: operationId: getWpV2Settings summary: GET /wp/v2/settings tags: - settings responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2Settings summary: POST /wp/v2/settings tags: - settings requestBody: required: false content: application/json: schema: type: object properties: date_format: type: string description: A date format for all date strings. default_category: type: integer description: Default post category. default_comment_status: type: string enum: - open - closed description: Allow people to submit comments on new posts. default_ping_status: type: string enum: - open - closed description: Allow link notifications from other blogs (pingbacks and trackbacks) on new articles. default_post_format: type: string description: Default post format. description: type: string description: Site tagline. email: type: string format: email description: This address is used for admin purposes, like new user notification. language: type: string description: WordPress locale code. page_for_posts: type: integer description: The ID of the page that should display the latest posts page_on_front: type: integer description: The ID of the page that should be displayed on the front page posts_per_page: type: integer description: Blog pages show at most. show_on_front: type: string description: What to show on the front page site_icon: type: integer description: Site icon. site_logo: type: integer description: Site logo. start_of_week: type: integer description: A day number of the week that the week should start on. themeisle_sdk_promotions: type: string themeisle_sdk_promotions_hyve_installed: type: boolean themeisle_sdk_promotions_masteriyo_installed: type: boolean themeisle_sdk_promotions_neve_installed: type: boolean themeisle_sdk_promotions_optimole_installed: type: boolean themeisle_sdk_promotions_otter_installed: type: boolean themeisle_sdk_promotions_redirection_cf7_installed: type: boolean themeisle_sdk_promotions_rop_installed: type: boolean themeisle_sdk_promotions_wp_full_pay_installed: type: boolean time_format: type: string description: A time format for all time strings. timezone: type: string description: A city in the same timezone as you. title: type: string description: Site title. url: type: string format: uri description: Site URL. use_smilies: type: boolean description: Convert emoticons like :-) and :-P to graphics on display. wordpress_api_key: type: string description: API key for the Akismet Anti-spam connector. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/sidebars: get: operationId: getWpV2Sidebars summary: GET /wp/v2/sidebars tags: - sidebars parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/sidebars/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2SidebarsById summary: GET /wp/v2/sidebars/{id} tags: - sidebars parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2SidebarsById summary: POST /wp/v2/sidebars/{id} tags: - sidebars requestBody: required: false content: application/json: schema: type: object properties: widgets: type: array items: type: object description: Nested widgets. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/statuses: get: operationId: getWpV2Statuses summary: GET /wp/v2/statuses tags: - statuses parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/statuses/{status}: parameters: - name: status in: path required: true schema: type: string get: operationId: getWpV2StatusesByStatus summary: GET /wp/v2/statuses/{status} tags: - statuses parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/tags: get: operationId: getWpV2Tags summary: GET /wp/v2/tags tags: - tags parameters: - 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: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: hide_empty in: query required: false schema: type: boolean default: false description: Whether to hide terms not assigned to any posts. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - 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: asc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name description: Sort collection by term attribute. - name: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 minimum: 1 maximum: 100 description: Maximum number of items to be returned in result set. - name: post in: query required: false schema: type: integer description: Limit result set to terms assigned to a specific post. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to terms with one or more specific slugs. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2Tags summary: POST /wp/v2/tags tags: - tags requestBody: required: true content: application/json: schema: type: object properties: description: type: string description: HTML description of the term. meta: type: object description: Meta fields. name: type: string description: HTML title for the term. slug: type: string description: An alphanumeric identifier for the term unique to its type. required: - name responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/tags/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2TagsById summary: GET /wp/v2/tags/{id} tags: - tags parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2TagsById summary: POST /wp/v2/tags/{id} tags: - tags requestBody: required: false content: application/json: schema: type: object properties: description: type: string description: HTML description of the term. meta: type: object description: Meta fields. name: type: string description: HTML title for the term. slug: type: string description: An alphanumeric identifier for the term unique to its type. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteWpV2TagsById summary: DELETE /wp/v2/tags/{id} tags: - tags requestBody: required: false content: application/json: schema: type: object properties: force: type: boolean default: false description: Required to be true, as terms do not support trashing. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/taxonomies: get: operationId: getWpV2Taxonomies summary: GET /wp/v2/taxonomies tags: - taxonomies parameters: - 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: type in: query required: false schema: type: string description: Limit results to taxonomies associated with a specific post type. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/taxonomies/{taxonomy}: parameters: - name: taxonomy in: path required: true schema: type: string get: operationId: getWpV2TaxonomiesByTaxonomy summary: GET /wp/v2/taxonomies/{taxonomy} tags: - taxonomies parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/template-parts: get: operationId: getWpV2TemplateParts summary: GET /wp/v2/template-parts tags: - template-parts parameters: - name: area in: query required: false schema: type: string description: Limit to the specified template part area. - 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: post_type in: query required: false schema: type: string description: Post type to get the templates for. - name: wp_id in: query required: false schema: type: integer description: Limit to the specified post id. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2TemplateParts summary: POST /wp/v2/template-parts tags: - template-parts requestBody: required: true content: application/json: schema: type: object properties: area: type: string description: Where the template part is intended for use (header, footer, etc.) author: type: integer description: The ID for the author of the template. content: type: object default: '' description: Content of template. description: type: string default: '' description: Description of template. slug: type: string description: Unique slug identifying the template. status: type: string enum: - publish - future - draft - pending - private - acf-disabled default: publish description: Status of template. theme: type: string description: Theme identifier for the template. title: type: object default: '' description: Title of template. type: type: string description: Type of template. required: - slug responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/template-parts/lookup: get: operationId: getWpV2TemplatePartsLookup summary: GET /wp/v2/template-parts/lookup tags: - template-parts parameters: - name: is_custom in: query required: false schema: type: boolean description: Indicates if a template is custom or part of the template hierarchy - name: slug in: query required: true schema: type: string description: The slug of the template to get the fallback for - name: template_prefix in: query required: false schema: type: string description: The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy` responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/template-parts/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2TemplatePartsById summary: GET /wp/v2/template-parts/{id} tags: - template-parts parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2TemplatePartsById summary: POST /wp/v2/template-parts/{id} tags: - template-parts requestBody: required: false content: application/json: schema: type: object properties: area: type: string description: Where the template part is intended for use (header, footer, etc.) author: type: integer description: The ID for the author of the template. content: type: object description: Content of template. description: type: string description: Description of template. slug: type: string description: Unique slug identifying the template. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: Status of template. theme: type: string description: Theme identifier for the template. title: type: object description: Title of template. type: type: string description: Type of template. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteWpV2TemplatePartsById summary: DELETE /wp/v2/template-parts/{id} tags: - template-parts requestBody: required: false content: application/json: schema: type: object properties: force: type: boolean default: false description: Whether to bypass Trash and force deletion. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/template-parts/{id}/autosaves: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2TemplatePartsByIdAutosaves summary: GET /wp/v2/template-parts/{id}/autosaves tags: - template-parts parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2TemplatePartsByIdAutosaves summary: POST /wp/v2/template-parts/{id}/autosaves tags: - template-parts requestBody: required: false content: application/json: schema: type: object properties: area: type: string description: Where the template part is intended for use (header, footer, etc.) author: type: integer description: The ID for the author of the template. content: type: object description: Content of template. description: type: string description: Description of template. slug: type: string description: Unique slug identifying the template. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: Status of template. theme: type: string description: Theme identifier for the template. title: type: object description: Title of template. type: type: string description: Type of template. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/template-parts/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2TemplatePartsByParentAutosavesById summary: GET /wp/v2/template-parts/{parent}/autosaves/{id} tags: - template-parts parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/template-parts/{parent}/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: getWpV2TemplatePartsByParentRevisions summary: GET /wp/v2/template-parts/{parent}/revisions tags: - template-parts parameters: - 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: 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: 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: - date - id - include - relevance - slug - include_slugs - title default: date description: Sort collection by object attribute. - name: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer minimum: 1 maximum: 100 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/template-parts/{parent}/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2TemplatePartsByParentRevisionsById summary: GET /wp/v2/template-parts/{parent}/revisions/{id} tags: - template-parts parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2TemplatePartsByParentRevisionsById summary: DELETE /wp/v2/template-parts/{parent}/revisions/{id} tags: - template-parts requestBody: required: false content: application/json: schema: type: object properties: force: type: boolean default: false description: Required to be true, as revisions do not support trashing. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/templates: get: operationId: getWpV2Templates summary: GET /wp/v2/templates tags: - templates parameters: - name: area in: query required: false schema: type: string description: Limit to the specified template part area. - 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: post_type in: query required: false schema: type: string description: Post type to get the templates for. - name: wp_id in: query required: false schema: type: integer description: Limit to the specified post id. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2Templates summary: POST /wp/v2/templates tags: - templates requestBody: required: true content: application/json: schema: type: object properties: author: type: integer description: The ID for the author of the template. content: type: object default: '' description: Content of template. description: type: string default: '' description: Description of template. slug: type: string description: Unique slug identifying the template. status: type: string enum: - publish - future - draft - pending - private - acf-disabled default: publish description: Status of template. theme: type: string description: Theme identifier for the template. title: type: object default: '' description: Title of template. type: type: string description: Type of template. required: - slug responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/templates/lookup: get: operationId: getWpV2TemplatesLookup summary: GET /wp/v2/templates/lookup tags: - templates parameters: - name: is_custom in: query required: false schema: type: boolean description: Indicates if a template is custom or part of the template hierarchy - name: slug in: query required: true schema: type: string description: The slug of the template to get the fallback for - name: template_prefix in: query required: false schema: type: string description: The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy` responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/templates/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2TemplatesById summary: GET /wp/v2/templates/{id} tags: - templates parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2TemplatesById summary: POST /wp/v2/templates/{id} tags: - templates requestBody: required: false content: application/json: schema: type: object properties: author: type: integer description: The ID for the author of the template. content: type: object description: Content of template. description: type: string description: Description of template. slug: type: string description: Unique slug identifying the template. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: Status of template. theme: type: string description: Theme identifier for the template. title: type: object description: Title of template. type: type: string description: Type of template. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteWpV2TemplatesById summary: DELETE /wp/v2/templates/{id} tags: - templates requestBody: required: false content: application/json: schema: type: object properties: force: type: boolean default: false description: Whether to bypass Trash and force deletion. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/templates/{id}/autosaves: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2TemplatesByIdAutosaves summary: GET /wp/v2/templates/{id}/autosaves tags: - templates parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2TemplatesByIdAutosaves summary: POST /wp/v2/templates/{id}/autosaves tags: - templates requestBody: required: false content: application/json: schema: type: object properties: author: type: integer description: The ID for the author of the template. content: type: object description: Content of template. description: type: string description: Description of template. slug: type: string description: Unique slug identifying the template. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: Status of template. theme: type: string description: Theme identifier for the template. title: type: object description: Title of template. type: type: string description: Type of template. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/templates/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2TemplatesByParentAutosavesById summary: GET /wp/v2/templates/{parent}/autosaves/{id} tags: - templates parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/templates/{parent}/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: getWpV2TemplatesByParentRevisions summary: GET /wp/v2/templates/{parent}/revisions tags: - templates parameters: - 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: 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: 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: - date - id - include - relevance - slug - include_slugs - title default: date description: Sort collection by object attribute. - name: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer minimum: 1 maximum: 100 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/templates/{parent}/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2TemplatesByParentRevisionsById summary: GET /wp/v2/templates/{parent}/revisions/{id} tags: - templates parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2TemplatesByParentRevisionsById summary: DELETE /wp/v2/templates/{parent}/revisions/{id} tags: - templates requestBody: required: false content: application/json: schema: type: object properties: force: type: boolean default: false description: Required to be true, as revisions do not support trashing. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/themes: get: operationId: getWpV2Themes summary: GET /wp/v2/themes tags: - themes parameters: - name: status in: query required: false schema: type: array items: type: string enum: - active - inactive description: Limit result set to themes assigned one or more statuses. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/themes/{stylesheet}: parameters: - name: stylesheet in: path required: true schema: type: string get: operationId: getWpV2ThemesByStylesheet summary: GET /wp/v2/themes/{stylesheet} tags: - themes responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/types: get: operationId: getWpV2Types summary: GET /wp/v2/types tags: - types parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/types/{type}: parameters: - name: type in: path required: true schema: type: string get: operationId: getWpV2TypesByType summary: GET /wp/v2/types/{type} tags: - types parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/users: get: operationId: getWpV2Users summary: GET /wp/v2/users tags: - users parameters: - name: capabilities in: query required: false schema: type: array items: type: string description: Limit result set to users matching at least one specific capability provided. Accepts csv list or single capability. - 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: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: has_published_posts in: query required: false schema: type: boolean description: Limit result set to users who have published posts. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - 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: asc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - id - include - name - registered_date - slug - include_slugs - email - url default: name description: Sort collection by user attribute. - name: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 minimum: 1 maximum: 100 description: Maximum number of items to be returned in result set. - name: roles in: query required: false schema: type: array items: type: string description: Limit result set to users matching at least one specific role provided. Accepts csv list or single role. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: search_columns in: query required: false schema: type: array default: [] items: type: string enum: - email - name - id - username - slug 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 users with one or more specific slugs. - name: who in: query required: false schema: type: string enum: - authors description: Limit result set to users who are considered authors. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2Users summary: POST /wp/v2/users tags: - users requestBody: required: true content: application/json: schema: type: object properties: description: type: string description: Description of the user. email: type: string format: email description: The email address for the user. first_name: type: string description: First name for the user. last_name: type: string description: Last name for the user. locale: type: string enum: - '' - en_US description: Locale for the user. meta: type: object description: Meta fields. name: type: string description: Display name for the user. nickname: type: string description: The nickname for the user. password: type: string description: Password for the user (never included). roles: type: array items: type: string description: Roles assigned to the user. slug: type: string description: An alphanumeric identifier for the user. url: type: string format: uri description: URL of the user. username: type: string description: Login name for the user. required: - email - password - username responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/users/me: get: operationId: getWpV2UsersMe summary: GET /wp/v2/users/me tags: - users parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2UsersMe summary: POST /wp/v2/users/me tags: - users requestBody: required: false content: application/json: schema: type: object properties: description: type: string description: Description of the user. email: type: string format: email description: The email address for the user. first_name: type: string description: First name for the user. last_name: type: string description: Last name for the user. locale: type: string enum: - '' - en_US description: Locale for the user. meta: type: object description: Meta fields. name: type: string description: Display name for the user. nickname: type: string description: The nickname for the user. password: type: string description: Password for the user (never included). roles: type: array items: type: string description: Roles assigned to the user. slug: type: string description: An alphanumeric identifier for the user. url: type: string format: uri description: URL of the user. username: type: string description: Login name for the user. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteWpV2UsersMe summary: DELETE /wp/v2/users/me tags: - users requestBody: required: true content: application/json: schema: type: object properties: force: type: boolean default: false description: Required to be true, as users do not support trashing. reassign: type: integer description: Reassign the deleted user's posts and links to this user ID. required: - reassign responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/users/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2UsersById summary: GET /wp/v2/users/{id} tags: - users parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2UsersById summary: POST /wp/v2/users/{id} tags: - users requestBody: required: false content: application/json: schema: type: object properties: description: type: string description: Description of the user. email: type: string format: email description: The email address for the user. first_name: type: string description: First name for the user. last_name: type: string description: Last name for the user. locale: type: string enum: - '' - en_US description: Locale for the user. meta: type: object description: Meta fields. name: type: string description: Display name for the user. nickname: type: string description: The nickname for the user. password: type: string description: Password for the user (never included). roles: type: array items: type: string description: Roles assigned to the user. slug: type: string description: An alphanumeric identifier for the user. url: type: string format: uri description: URL of the user. username: type: string description: Login name for the user. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteWpV2UsersById summary: DELETE /wp/v2/users/{id} tags: - users requestBody: required: true content: application/json: schema: type: object properties: force: type: boolean default: false description: Required to be true, as users do not support trashing. reassign: type: integer description: Reassign the deleted user's posts and links to this user ID. required: - reassign responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/users/{user_id}/application-passwords: parameters: - name: user_id in: path required: true schema: type: string get: operationId: getWpV2UsersByUserIdApplicationPasswords summary: GET /wp/v2/users/{user_id}/application-passwords tags: - users parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2UsersByUserIdApplicationPasswords summary: POST /wp/v2/users/{user_id}/application-passwords tags: - users requestBody: required: true content: application/json: schema: type: object properties: app_id: type: string description: A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace. name: type: string description: The name of the application password. required: - name responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteWpV2UsersByUserIdApplicationPasswords summary: DELETE /wp/v2/users/{user_id}/application-passwords tags: - users responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/users/{user_id}/application-passwords/introspect: parameters: - name: user_id in: path required: true schema: type: string get: operationId: getWpV2UsersByUserIdApplicationPasswordsIntrospect summary: GET /wp/v2/users/{user_id}/application-passwords/introspect tags: - users parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/users/{user_id}/application-passwords/{uuid}: parameters: - name: user_id in: path required: true schema: type: string - name: uuid in: path required: true schema: type: string get: operationId: getWpV2UsersByUserIdApplicationPasswordsByUuid summary: GET /wp/v2/users/{user_id}/application-passwords/{uuid} tags: - users parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2UsersByUserIdApplicationPasswordsByUuid summary: POST /wp/v2/users/{user_id}/application-passwords/{uuid} tags: - users requestBody: required: false content: application/json: schema: type: object properties: app_id: type: string description: A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace. name: type: string description: The name of the application password. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteWpV2UsersByUserIdApplicationPasswordsByUuid summary: DELETE /wp/v2/users/{user_id}/application-passwords/{uuid} tags: - users responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/widget-types: get: operationId: getWpV2WidgetTypes summary: GET /wp/v2/widget-types tags: - widget-types parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/widget-types/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2WidgetTypesById summary: GET /wp/v2/widget-types/{id} tags: - widget-types parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/widget-types/{id}/encode: parameters: - name: id in: path required: true schema: type: string post: operationId: createWpV2WidgetTypesByIdEncode summary: POST /wp/v2/widget-types/{id}/encode tags: - widget-types requestBody: required: false content: application/json: schema: type: object properties: form_data: type: string description: Serialized widget form data to encode into instance settings. instance: type: object description: Current instance settings of the widget. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/widget-types/{id}/render: parameters: - name: id in: path required: true schema: type: string post: operationId: createWpV2WidgetTypesByIdRender summary: POST /wp/v2/widget-types/{id}/render tags: - widget-types requestBody: required: false content: application/json: schema: type: object properties: instance: type: object description: Current instance settings of the widget. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/widgets: get: operationId: getWpV2Widgets summary: GET /wp/v2/widgets tags: - widgets parameters: - 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: sidebar in: query required: false schema: type: string description: The sidebar to return widgets for. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2Widgets summary: POST /wp/v2/widgets tags: - widgets requestBody: required: true content: application/json: schema: type: object properties: form_data: type: string description: URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only. id: type: string description: Unique identifier for the widget. id_base: type: string description: The type of the widget. Corresponds to ID in widget-types endpoint. instance: type: object description: Instance settings of the widget, if supported. sidebar: type: string default: wp_inactive_widgets description: The sidebar the widget belongs to. required: - sidebar responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/widgets/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2WidgetsById summary: GET /wp/v2/widgets/{id} tags: - widgets parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2WidgetsById summary: POST /wp/v2/widgets/{id} tags: - widgets requestBody: required: false content: application/json: schema: type: object properties: form_data: type: string description: URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only. id_base: type: string description: The type of the widget. Corresponds to ID in widget-types endpoint. instance: type: object description: Instance settings of the widget, if supported. sidebar: type: string description: The sidebar the widget belongs to. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteWpV2WidgetsById summary: DELETE /wp/v2/widgets/{id} tags: - widgets requestBody: required: false content: application/json: schema: type: object properties: force: type: boolean description: Whether to force removal of the widget, or move it to the inactive sidebar. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/wp_pattern_category: get: operationId: getWpV2WpPatternCategory summary: GET /wp/v2/wp_pattern_category tags: - wp_pattern_category parameters: - 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: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: hide_empty in: query required: false schema: type: boolean default: false description: Whether to hide terms not assigned to any posts. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - 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: asc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name description: Sort collection by term attribute. - name: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 minimum: 1 maximum: 100 description: Maximum number of items to be returned in result set. - name: post in: query required: false schema: type: integer description: Limit result set to terms assigned to a specific post. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to terms with one or more specific slugs. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2WpPatternCategory summary: POST /wp/v2/wp_pattern_category tags: - wp_pattern_category requestBody: required: true content: application/json: schema: type: object properties: description: type: string description: HTML description of the term. meta: type: object description: Meta fields. name: type: string description: HTML title for the term. slug: type: string description: An alphanumeric identifier for the term unique to its type. required: - name responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/wp_pattern_category/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2WpPatternCategoryById summary: GET /wp/v2/wp_pattern_category/{id} tags: - wp_pattern_category parameters: - 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. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: createWpV2WpPatternCategoryById summary: POST /wp/v2/wp_pattern_category/{id} tags: - wp_pattern_category requestBody: required: false content: application/json: schema: type: object properties: description: type: string description: HTML description of the term. meta: type: object description: Meta fields. name: type: string description: HTML title for the term. slug: type: string description: An alphanumeric identifier for the term unique to its type. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteWpV2WpPatternCategoryById summary: DELETE /wp/v2/wp_pattern_category/{id} tags: - wp_pattern_category requestBody: required: false content: application/json: schema: type: object properties: force: type: boolean default: false description: Required to be true, as terms do not support trashing. responses: '200': description: Success headers: X-WP-Total: description: Total number of matching records (collection routes) schema: type: integer X-WP-TotalPages: description: Total number of pages (collection routes) schema: type: integer Link: description: RFC 8288 pagination links (rel=next / rel=prev) schema: type: string content: application/json: schema: {} '400': description: rest_invalid_param — a parameter failed validation content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: rest_forbidden — authentication required for this route content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: rest_forbidden / rest_cannot_* — authenticated but not permitted content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: rest_no_route / rest_post_invalid_id — route or resource not found content: application/json: schema: $ref: '#/components/schemas/WPError' security: - basicAuth: [] - cookieNonce: [] components: securitySchemes: basicAuth: type: http scheme: basic description: WordPress application passwords, advertised by the site's own discovery document at https://www.bxp.com/wp-json/ (authentication.application-passwords.endpoints.authorization = https://www.bxp.com/wp-admin/authorize-application.php). Issued only to WordPress user accounts on the BXP site; not available to third parties. cookieNonce: type: apiKey in: header name: X-WP-Nonce description: WordPress logged-in cookie plus an X-WP-Nonce header. Advertised by the Access-Control-Allow-Headers response header observed on https://www.bxp.com/wp-json/wp/v2/pages (2026-09-04). schemas: WPError: type: object description: The WordPress REST error envelope, observed verbatim on https://www.bxp.com/wp-json/wp/v2/settings (HTTP 401, 2026-09-04). Not RFC 9457 problem+json. properties: code: type: string examples: - rest_forbidden message: type: string examples: - Sorry, you are not allowed to do that. data: type: object properties: status: type: integer examples: - 401 required: - code - message - data x-generated-from: https://www.bxp.com/wp-json/ (WordPress REST route-discovery document, HTTP 200, 2026-09-04) x-generated-by: API Evangelist enrichment pipeline — mechanical transform of the provider-served route index; no hand-authored operations