openapi: 3.1.0 info: title: Offerpad WordPress REST API (wp/v2) version: 2.0.0 summary: The wp/v2 namespace of the WordPress REST API served by Offerpad's marketing site. description: DERIVED, NOT PUBLISHED BY OFFERPAD. Offerpad publishes no OpenAPI definition and does not document or support this surface as a developer product. This document was derived mechanically by API Evangelist from the live WordPress route-discovery document fetched from https://www.offerpad.com/wp-json/ on 2026-07-26 (411 routes across 20 namespaces; the wp/v2 namespace is captured here). Every path, method, parameter name, type, enum, default and description is copied verbatim from that discovery document. Response bodies are intentionally left as generic objects because the discovery document does not publish response schemas; error responses are grounded in payloads probed live against this host. This is a content-management surface for the marketing site - it is NOT a real estate, listing, valuation or transaction API. contact: name: Offerpad url: https://www.offerpad.com/contact/ x-apievangelist-method: derived x-apievangelist-source: openapi/offerpad-wp-json-discovery.json x-apievangelist-derived: '2026-07-26' x-upstream-documentation: https://developer.wordpress.org/rest-api/ servers: - url: https://www.offerpad.com/wp-json description: Offerpad marketing site (WP Engine) tags: - name: index description: WordPress index resource routes. - name: block-directory description: WordPress block-directory resource routes. - name: block-patterns description: WordPress block-patterns resource routes. - name: block-renderer description: WordPress block-renderer resource routes. - name: block-types description: WordPress block-types resource routes. - name: blocks description: WordPress blocks resource routes. - name: categories description: WordPress categories resource routes. - name: comments description: WordPress comments resource routes. - name: e-floating-buttons description: WordPress e-floating-buttons resource routes. - name: elementor_library description: WordPress elementor_library resource routes. - name: elementor_snippet description: WordPress elementor_snippet resource routes. - name: font-collections description: WordPress font-collections resource routes. - name: font-families description: WordPress font-families resource routes. - name: global-styles description: WordPress global-styles resource routes. - name: icons description: WordPress icons resource routes. - name: locations description: WordPress locations resource routes. - name: media description: WordPress media resource routes. - name: menu-items description: WordPress menu-items resource routes. - name: menu-locations description: WordPress menu-locations resource routes. - name: menus description: WordPress menus resource routes. - name: navigation description: WordPress navigation resource routes. - name: pages description: WordPress pages resource routes. - name: pattern-directory description: WordPress pattern-directory resource routes. - name: plugins description: WordPress plugins resource routes. - name: posts description: WordPress posts resource routes. - name: review description: WordPress review resource routes. - name: search description: WordPress search resource routes. - name: settings description: WordPress settings resource routes. - name: sidebars description: WordPress sidebars resource routes. - name: states description: WordPress states resource routes. - name: statuses description: WordPress statuses resource routes. - name: tags description: WordPress tags resource routes. - name: taxonomies description: WordPress taxonomies resource routes. - name: template-parts description: WordPress template-parts resource routes. - name: templates description: WordPress templates resource routes. - name: themes description: WordPress themes resource routes. - name: types description: WordPress types resource routes. - name: users description: WordPress users resource routes. - name: widget-types description: WordPress widget-types resource routes. - name: widgets description: WordPress widgets resource routes. - name: wp_pattern_category description: WordPress wp_pattern_category resource routes. components: securitySchemes: applicationPasswords: type: http scheme: basic description: WordPress application passwords, advertised by the discovery document at https://www.offerpad.com/wp-admin/authorize-application.php. Sent as HTTP Basic credentials. Required for write operations and for reads in the edit context; issuing a credential requires an Offerpad WordPress account, which is not self-serve. schemas: WPError: type: object description: WordPress REST error envelope, observed live on this host. properties: code: type: string description: Machine-readable error code, e.g. rest_no_route. message: type: string description: Human-readable error message. data: type: object properties: status: type: integer description: HTTP status code, repeated in the body. params: type: object description: Per-parameter validation messages (rest_invalid_param). details: type: object description: Per-parameter structured error detail. required: - code - message examples: - code: rest_post_invalid_id message: Invalid post ID. data: status: 404 security: [] paths: /wp/v2: get: operationId: getNamespaceIndex summary: Get the wp/v2 namespace index tags: - index parameters: - name: namespace schema: default: wp/v2 required: false in: query - name: context schema: default: view required: false in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': &id001 description: 'Invalid parameter(s). Probed live: {"code":"rest_invalid_param"}' content: application/json: schema: $ref: '#/components/schemas/WPError' '401': &id002 description: 'Authentication required or capability missing. Probed live: {"code":"rest_forbidden"}' content: application/json: schema: $ref: '#/components/schemas/WPError' '404': &id003 description: 'No route matched, or the resource id is invalid. Probed live: {"code":"rest_no_route"} / {"code":"rest_post_invalid_id"}' content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/block-directory/search: get: operationId: listBlockDirectorySearch summary: List block directory search tags: - block-directory parameters: - name: context schema: type: string enum: - view default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 10 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: term schema: type: string minLength: 1 required: true description: Limit result set to blocks matching the search term. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/block-patterns/categories: get: operationId: listBlockPatternsCategories summary: List block patterns categories tags: - block-patterns responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/block-patterns/patterns: get: operationId: listBlockPatternsPatterns summary: List block patterns patterns tags: - block-patterns responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/block-renderer/{name}: get: operationId: getBlockRendererByName summary: Retrieve block renderer tags: - block-renderer parameters: - name: name in: path required: true schema: type: string description: Unique registered name for the block. - name: context schema: type: string enum: &id004 - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: attributes schema: type: object default: &id005 [] required: false description: Attributes for the block. in: query - name: post_id schema: type: integer required: false description: ID of the post context. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createBlockRendererByName summary: Create block renderer tags: - block-renderer parameters: - name: name in: path required: true schema: type: string description: Unique registered name for the block. requestBody: required: false content: application/json: schema: type: object properties: context: type: string enum: *id004 default: view description: Scope under which the request is made; determines fields present in response. attributes: type: object default: *id005 description: Attributes for the block. post_id: type: integer description: ID of the post context. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/block-types: get: operationId: listBlockTypes summary: List block types tags: - block-types parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: namespace schema: type: string required: false description: Block namespace. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/block-types/{namespace}: get: operationId: getBlockTypesByNamespace summary: Retrieve block types tags: - block-types parameters: - name: namespace in: path required: true schema: type: string description: Block namespace. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/block-types/{namespace}/{name}: get: operationId: getBlockTypesByNamespaceByName summary: Retrieve block types tags: - block-types parameters: - name: name in: path required: true schema: type: string description: Block name. - name: namespace in: path required: true schema: type: string description: Block namespace. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/blocks: get: operationId: listBlocks summary: List blocks tags: - blocks parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 10 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: after schema: type: string format: date-time required: false description: Limit response to posts published after a given ISO8601 compliant date. in: query - name: modified_after schema: type: string format: date-time required: false description: Limit response to posts modified after a given ISO8601 compliant date. in: query - name: before schema: type: string format: date-time required: false description: Limit response to posts published before a given ISO8601 compliant date. in: query - name: modified_before schema: type: string format: date-time required: false description: Limit response to posts modified before a given ISO8601 compliant date. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: search_semantics schema: type: string enum: - exact required: false description: How to interpret the search input. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: desc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date required: false description: Sort collection by post attribute. in: query - name: search_columns schema: type: array default: [] items: type: string enum: - post_title - post_content - post_excerpt required: false description: Array of column names to be searched. in: query - name: slug schema: type: array items: type: string required: false description: Limit result set to posts with one or more specific slugs. in: query - name: status 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 - any required: false description: Limit result set to posts assigned one or more statuses. in: query - name: tax_relation schema: type: string enum: - AND - OR required: false description: Limit result set based on relationship between multiple taxonomies. in: query - name: wp_pattern_category schema: type: - object - array required: false description: Limit result set to items with specific terms assigned in the wp_pattern_category taxonomy. in: query - name: wp_pattern_category_exclude schema: type: - object - array required: false description: Limit result set to items except those with specific terms assigned in the wp_pattern_category taxonomy. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createBlocks summary: Create blocks tags: - blocks requestBody: required: false content: application/json: schema: type: object properties: date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object description: The title for the post. content: type: object description: The content for the post. excerpt: type: object description: The excerpt for the post. meta: type: object description: Meta fields. template: type: string description: The theme file to use to display the post. wp_pattern_category: type: array items: type: integer description: The terms assigned to the post in the wp_pattern_category taxonomy. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/blocks/{id}: get: operationId: getBlocksById summary: Retrieve blocks tags: - blocks parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: excerpt_length schema: type: integer required: false description: Override the default excerpt length. in: query - name: password schema: type: string required: false description: The password for the post if it is password protected. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createBlocksById summary: Create blocks tags: - blocks parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. requestBody: required: false content: application/json: schema: type: object properties: date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object description: The title for the post. content: type: object description: The content for the post. excerpt: type: object description: The excerpt for the post. meta: type: object description: Meta fields. template: type: string description: The theme file to use to display the post. wp_pattern_category: type: array items: type: integer description: The terms assigned to the post in the wp_pattern_category taxonomy. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteBlocksById summary: Delete blocks tags: - blocks parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. - name: force schema: type: boolean default: false required: false description: Whether to bypass Trash and force deletion. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/blocks/{id}/autosaves: get: operationId: getBlocksByIdAutosaves summary: Retrieve blocks autosaves tags: - blocks parameters: - name: id in: path required: true schema: type: string description: Path parameter id declared by the route regex. - name: parent schema: type: integer required: false description: The ID for the parent of the autosave. in: query - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createBlocksByIdAutosaves summary: Create blocks autosaves tags: - blocks parameters: - name: id in: path required: true schema: type: string description: Path parameter id declared by the route regex. requestBody: required: false content: application/json: schema: type: object properties: parent: type: integer description: The ID for the parent of the autosave. date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object description: The title for the post. content: type: object description: The content for the post. excerpt: type: object description: The excerpt for the post. meta: type: object description: Meta fields. template: type: string description: The theme file to use to display the post. wp_pattern_category: type: array items: type: integer description: The terms assigned to the post in the wp_pattern_category taxonomy. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/blocks/{parent}/autosaves/{id}: get: operationId: getBlocksByParentAutosavesById summary: Retrieve blocks autosaves tags: - blocks parameters: - name: id in: path required: true schema: type: integer description: The ID for the autosave. - name: parent in: path required: true schema: type: integer description: The ID for the parent of the autosave. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/blocks/{parent}/revisions: get: operationId: getBlocksByParentRevisions summary: Retrieve blocks revisions tags: - blocks parameters: - name: parent in: path required: true schema: type: integer description: The ID for the parent of the revision. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: desc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date required: false description: Sort collection by object attribute. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/blocks/{parent}/revisions/{id}: get: operationId: getBlocksByParentRevisionsById summary: Retrieve blocks revisions tags: - blocks parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the revision. - name: parent in: path required: true schema: type: integer description: The ID for the parent of the revision. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteBlocksByParentRevisionsById summary: Delete blocks revisions tags: - blocks parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the revision. - name: parent in: path required: true schema: type: integer description: The ID for the parent of the revision. - name: force schema: type: boolean default: false required: false description: Required to be true, as revisions do not support trashing. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/categories: get: operationId: listCategories summary: List categories tags: - categories parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 10 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: order schema: type: string enum: - asc - desc default: asc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name required: false description: Sort collection by term attribute. in: query - name: hide_empty schema: type: boolean default: false required: false description: Whether to hide terms not assigned to any posts. in: query - name: parent schema: type: integer required: false description: Limit result set to terms assigned to a specific parent. in: query - name: post schema: type: integer default: null required: false description: Limit result set to terms assigned to a specific post. in: query - name: slug schema: type: array items: type: string required: false description: Limit result set to terms with one or more specific slugs. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createCategories summary: Create categories tags: - categories requestBody: required: true content: application/json: schema: type: object properties: description: type: string description: HTML description of the term. name: type: string description: HTML title for the term. slug: type: string description: An alphanumeric identifier for the term unique to its type. parent: type: integer description: The parent term ID. meta: type: object description: Meta fields. required: - name security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/categories/{id}: get: operationId: getCategoriesById summary: Retrieve categories tags: - categories parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the term. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createCategoriesById summary: Create categories tags: - categories parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the term. requestBody: required: false content: application/json: schema: type: object properties: description: type: string description: HTML description of the term. name: type: string description: HTML title for the term. slug: type: string description: An alphanumeric identifier for the term unique to its type. parent: type: integer description: The parent term ID. meta: type: object description: Meta fields. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteCategoriesById summary: Delete categories tags: - categories parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the term. - name: force schema: type: boolean default: false required: false description: Required to be true, as terms do not support trashing. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/comments: get: operationId: listComments summary: List comments tags: - comments parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 10 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: after schema: type: string format: date-time required: false description: Limit response to comments published after a given ISO8601 compliant date. in: query - name: author schema: type: array items: type: integer required: false description: Limit result set to comments assigned to specific user IDs. Requires authorization. in: query - name: author_exclude schema: type: array items: type: integer required: false description: Ensure result set excludes comments assigned to specific user IDs. Requires authorization. in: query - name: author_email schema: type: string format: email default: null required: false description: Limit result set to that from a specific author email. Requires authorization. in: query - name: before schema: type: string format: date-time required: false description: Limit response to comments published before a given ISO8601 compliant date. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: desc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - date - date_gmt - id - include - post - parent - type default: date_gmt required: false description: Sort collection by comment attribute. in: query - name: parent schema: type: array default: [] items: type: integer required: false description: Limit result set to comments of specific parent IDs. in: query - name: parent_exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific parent IDs. in: query - name: post schema: type: array default: [] items: type: integer required: false description: Limit result set to comments assigned to specific post IDs. in: query - name: status schema: type: string default: approve required: false description: Limit result set to comments assigned a specific status. Requires authorization. in: query - name: type schema: type: string default: comment required: false description: Limit result set to comments assigned a specific type. Requires authorization. in: query - name: password schema: type: string required: false description: The password for the post if it is password protected. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createComments summary: Create 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. 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. meta: type: object description: Meta fields. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/comments/{id}: get: operationId: getCommentsById summary: Retrieve comments tags: - comments parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the comment. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: password schema: type: string required: false description: The password for the parent post of the comment (if the post is password protected). in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createCommentsById summary: Create comments tags: - comments parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the comment. 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. 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. meta: type: object description: Meta fields. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteCommentsById summary: Delete comments tags: - comments parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the comment. - name: force schema: type: boolean default: false required: false description: Whether to bypass Trash and force deletion. in: query - name: password schema: type: string required: false description: The password for the parent post of the comment (if the post is password protected). in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/e-floating-buttons: get: operationId: listEFloatingButtons summary: List e floating buttons tags: - e-floating-buttons parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 10 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: after schema: type: string format: date-time required: false description: Limit response to posts published after a given ISO8601 compliant date. in: query - name: modified_after schema: type: string format: date-time required: false description: Limit response to posts modified after a given ISO8601 compliant date. in: query - name: author schema: type: array default: [] items: type: integer required: false description: Limit result set to posts assigned to specific authors. in: query - name: author_exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes posts assigned to specific authors. in: query - name: before schema: type: string format: date-time required: false description: Limit response to posts published before a given ISO8601 compliant date. in: query - name: modified_before schema: type: string format: date-time required: false description: Limit response to posts modified before a given ISO8601 compliant date. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: menu_order schema: type: integer required: false description: Limit result set to posts with a specific menu_order value. in: query - name: search_semantics schema: type: string enum: - exact required: false description: How to interpret the search input. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: desc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title - menu_order default: date required: false description: Sort collection by post attribute. in: query - name: search_columns schema: type: array default: [] items: type: string enum: - post_title - post_content - post_excerpt required: false description: Array of column names to be searched. in: query - name: slug schema: type: array items: type: string required: false description: Limit result set to posts with one or more specific slugs. in: query - name: status 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 - any required: false description: Limit result set to posts assigned one or more statuses. in: query - name: format schema: type: array items: type: string enum: - standard - aside - chat - gallery - link - image - quote - status - video - audio required: false description: Limit result set to items assigned one or more given formats. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createEFloatingButtons summary: Create e floating buttons tags: - e-floating-buttons requestBody: required: false content: application/json: schema: type: object properties: date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object description: The title for the post. content: type: object description: The content for the post. author: type: integer description: The ID for the author of the post. excerpt: type: object description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. comment_status: type: string enum: - open - closed description: Whether or not comments are open on the post. ping_status: type: string enum: - open - closed description: Whether or not the post can be pinged. menu_order: type: integer description: The order of the post in relation to other posts. 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. template: type: string description: The theme file to use to display the post. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/e-floating-buttons/{id}: get: operationId: getEFloatingButtonsById summary: Retrieve e floating buttons tags: - e-floating-buttons parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: excerpt_length schema: type: integer required: false description: Override the default excerpt length. in: query - name: password schema: type: string required: false description: The password for the post if it is password protected. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createEFloatingButtonsById summary: Create e floating buttons tags: - e-floating-buttons parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. requestBody: required: false content: application/json: schema: type: object properties: date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object description: The title for the post. content: type: object description: The content for the post. author: type: integer description: The ID for the author of the post. excerpt: type: object description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. comment_status: type: string enum: - open - closed description: Whether or not comments are open on the post. ping_status: type: string enum: - open - closed description: Whether or not the post can be pinged. menu_order: type: integer description: The order of the post in relation to other posts. 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. template: type: string description: The theme file to use to display the post. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteEFloatingButtonsById summary: Delete e floating buttons tags: - e-floating-buttons parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. - name: force schema: type: boolean default: false required: false description: Whether to bypass Trash and force deletion. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/e-floating-buttons/{id}/autosaves: get: operationId: getEFloatingButtonsByIdAutosaves summary: Retrieve e floating buttons autosaves tags: - e-floating-buttons parameters: - name: id in: path required: true schema: type: string description: Path parameter id declared by the route regex. - name: parent schema: type: integer required: false description: The ID for the parent of the autosave. in: query - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createEFloatingButtonsByIdAutosaves summary: Create e floating buttons autosaves tags: - e-floating-buttons parameters: - name: id in: path required: true schema: type: string description: Path parameter id declared by the route regex. requestBody: required: false content: application/json: schema: type: object properties: parent: type: integer description: The ID for the parent of the autosave. date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object description: The title for the post. content: type: object description: The content for the post. author: type: integer description: The ID for the author of the post. excerpt: type: object description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. comment_status: type: string enum: - open - closed description: Whether or not comments are open on the post. ping_status: type: string enum: - open - closed description: Whether or not the post can be pinged. menu_order: type: integer description: The order of the post in relation to other posts. 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. template: type: string description: The theme file to use to display the post. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/e-floating-buttons/{parent}/autosaves/{id}: get: operationId: getEFloatingButtonsByParentAutosavesById summary: Retrieve e floating buttons autosaves tags: - e-floating-buttons parameters: - name: id in: path required: true schema: type: integer description: The ID for the autosave. - name: parent in: path required: true schema: type: integer description: The ID for the parent of the autosave. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/e-floating-buttons/{parent}/revisions: get: operationId: getEFloatingButtonsByParentRevisions summary: Retrieve e floating buttons revisions tags: - e-floating-buttons parameters: - name: parent in: path required: true schema: type: integer description: The ID for the parent of the revision. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: desc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date required: false description: Sort collection by object attribute. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/e-floating-buttons/{parent}/revisions/{id}: get: operationId: getEFloatingButtonsByParentRevisionsById summary: Retrieve e floating buttons revisions tags: - e-floating-buttons parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the revision. - name: parent in: path required: true schema: type: integer description: The ID for the parent of the revision. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteEFloatingButtonsByParentRevisionsById summary: Delete e floating buttons revisions tags: - e-floating-buttons parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the revision. - name: parent in: path required: true schema: type: integer description: The ID for the parent of the revision. - name: force schema: type: boolean default: false required: false description: Required to be true, as revisions do not support trashing. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/elementor_library: get: operationId: listElementorLibrary summary: List elementor library tags: - elementor_library parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 10 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: after schema: type: string format: date-time required: false description: Limit response to posts published after a given ISO8601 compliant date. in: query - name: modified_after schema: type: string format: date-time required: false description: Limit response to posts modified after a given ISO8601 compliant date. in: query - name: author schema: type: array default: [] items: type: integer required: false description: Limit result set to posts assigned to specific authors. in: query - name: author_exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes posts assigned to specific authors. in: query - name: before schema: type: string format: date-time required: false description: Limit response to posts published before a given ISO8601 compliant date. in: query - name: modified_before schema: type: string format: date-time required: false description: Limit response to posts modified before a given ISO8601 compliant date. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: search_semantics schema: type: string enum: - exact required: false description: How to interpret the search input. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: desc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date required: false description: Sort collection by post attribute. in: query - name: search_columns schema: type: array default: [] items: type: string enum: - post_title - post_content - post_excerpt required: false description: Array of column names to be searched. in: query - name: slug schema: type: array items: type: string required: false description: Limit result set to posts with one or more specific slugs. in: query - name: status 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 - any required: false description: Limit result set to posts assigned one or more statuses. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createElementorLibrary summary: Create elementor library tags: - elementor_library requestBody: required: false content: application/json: schema: type: object properties: date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object description: The title for the post. author: type: integer description: The ID for the author of the post. featured_media: type: integer description: The ID of the featured media for the post. meta: type: object description: Meta fields. template: type: string description: The theme file to use to display the post. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/elementor_library/{id}: get: operationId: getElementorLibraryById summary: Retrieve elementor library tags: - elementor_library parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: password schema: type: string required: false description: The password for the post if it is password protected. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createElementorLibraryById summary: Create elementor library tags: - elementor_library parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. requestBody: required: false content: application/json: schema: type: object properties: date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object description: The title for the post. author: type: integer description: The ID for the author of the post. featured_media: type: integer description: The ID of the featured media for the post. meta: type: object description: Meta fields. template: type: string description: The theme file to use to display the post. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteElementorLibraryById summary: Delete elementor library tags: - elementor_library parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. - name: force schema: type: boolean default: false required: false description: Whether to bypass Trash and force deletion. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/elementor_library/{parent}/revisions: get: operationId: getElementorLibraryByParentRevisions summary: Retrieve elementor library revisions tags: - elementor_library parameters: - name: parent in: path required: true schema: type: integer description: The ID for the parent of the revision. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: desc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date required: false description: Sort collection by object attribute. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/elementor_library/{parent}/revisions/{id}: get: operationId: getElementorLibraryByParentRevisionsById summary: Retrieve elementor library revisions tags: - elementor_library parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the revision. - name: parent in: path required: true schema: type: integer description: The ID for the parent of the revision. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteElementorLibraryByParentRevisionsById summary: Delete elementor library revisions tags: - elementor_library parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the revision. - name: parent in: path required: true schema: type: integer description: The ID for the parent of the revision. - name: force schema: type: boolean default: false required: false description: Required to be true, as revisions do not support trashing. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/elementor_snippet: get: operationId: listElementorSnippet summary: List elementor snippet tags: - elementor_snippet parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 10 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: after schema: type: string format: date-time required: false description: Limit response to posts published after a given ISO8601 compliant date. in: query - name: modified_after schema: type: string format: date-time required: false description: Limit response to posts modified after a given ISO8601 compliant date. in: query - name: author schema: type: array default: [] items: type: integer required: false description: Limit result set to posts assigned to specific authors. in: query - name: author_exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes posts assigned to specific authors. in: query - name: before schema: type: string format: date-time required: false description: Limit response to posts published before a given ISO8601 compliant date. in: query - name: modified_before schema: type: string format: date-time required: false description: Limit response to posts modified before a given ISO8601 compliant date. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: search_semantics schema: type: string enum: - exact required: false description: How to interpret the search input. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: desc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date required: false description: Sort collection by post attribute. in: query - name: search_columns schema: type: array default: [] items: type: string enum: - post_title - post_content - post_excerpt required: false description: Array of column names to be searched. in: query - name: slug schema: type: array items: type: string required: false description: Limit result set to posts with one or more specific slugs. in: query - name: status 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 - any required: false description: Limit result set to posts assigned one or more statuses. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createElementorSnippet summary: Create elementor snippet tags: - elementor_snippet requestBody: required: false content: application/json: schema: type: object properties: date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object description: The title for the post. author: type: integer description: The ID for the author of the post. meta: type: object description: Meta fields. template: type: string description: The theme file to use to display the post. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/elementor_snippet/{id}: get: operationId: getElementorSnippetById summary: Retrieve elementor snippet tags: - elementor_snippet parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: password schema: type: string required: false description: The password for the post if it is password protected. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createElementorSnippetById summary: Create elementor snippet tags: - elementor_snippet parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. requestBody: required: false content: application/json: schema: type: object properties: date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object description: The title for the post. author: type: integer description: The ID for the author of the post. meta: type: object description: Meta fields. template: type: string description: The theme file to use to display the post. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteElementorSnippetById summary: Delete elementor snippet tags: - elementor_snippet parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. - name: force schema: type: boolean default: false required: false description: Whether to bypass Trash and force deletion. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/font-collections: get: operationId: listFontCollections summary: List font collections tags: - font-collections parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 10 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/font-collections/{slug}: get: operationId: getFontCollectionsBySlug summary: Retrieve font collections tags: - font-collections parameters: - name: slug in: path required: true schema: type: string description: Path parameter slug declared by the route regex. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/font-families: get: operationId: listFontFamilies summary: List font families tags: - font-families parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 10 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: search_semantics schema: type: string enum: - exact required: false description: How to interpret the search input. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: desc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - id - include default: id required: false description: Sort collection by post attribute. in: query - name: slug schema: type: array items: type: string required: false description: Limit result set to posts with one or more specific slugs. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createFontFamilies summary: Create font families tags: - font-families requestBody: required: true content: application/json: schema: type: object properties: theme_json_version: type: integer default: 3 minimum: 2 maximum: 3 description: Version of the theme.json schema used for the typography settings. font_family_settings: type: string description: font-family declaration in theme.json format, encoded as a string. required: - font_family_settings security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/font-families/{font_family_id}/font-faces: get: operationId: getFontFamiliesByFont_Family_IdFontFaces summary: Retrieve font families font faces tags: - font-families parameters: - name: font_family_id in: path required: true schema: type: integer description: The ID for the parent font family of the font face. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 10 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: search_semantics schema: type: string enum: - exact required: false description: How to interpret the search input. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: desc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - id - include default: id required: false description: Sort collection by post attribute. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createFontFamiliesByFont_Family_IdFontFaces summary: Create font families font faces tags: - font-families parameters: - name: font_family_id in: path required: true schema: type: integer description: The ID for the parent font family of the font face. requestBody: required: true content: application/json: schema: type: object properties: theme_json_version: type: integer default: 3 minimum: 2 maximum: 3 description: Version of the theme.json schema used for the typography settings. font_face_settings: type: string description: font-face declaration in theme.json format, encoded as a string. required: - font_face_settings security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/font-families/{font_family_id}/font-faces/{id}: get: operationId: getFontFamiliesByFont_Family_IdFontFacesById summary: Retrieve font families font faces tags: - font-families parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the font face. - name: font_family_id in: path required: true schema: type: integer description: The ID for the parent font family of the font face. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteFontFamiliesByFont_Family_IdFontFacesById summary: Delete font families font faces tags: - font-families parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the font face. - name: font_family_id in: path required: true schema: type: integer description: The ID for the parent font family of the font face. - name: force schema: type: boolean default: false required: false description: Whether to bypass Trash and force deletion. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/font-families/{id}: get: operationId: getFontFamiliesById summary: Retrieve font families tags: - font-families parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createFontFamiliesById summary: Create font families tags: - font-families parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. requestBody: required: true content: application/json: schema: type: object properties: theme_json_version: type: integer default: 3 minimum: 2 maximum: 3 description: Version of the theme.json schema used for the typography settings. font_family_settings: type: string description: font-family declaration in theme.json format, encoded as a string. required: - font_family_settings security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteFontFamiliesById summary: Delete font families tags: - font-families parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. - name: force schema: type: boolean default: false required: false description: Whether to bypass Trash and force deletion. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/global-styles/{id}: get: operationId: getGlobalStylesById summary: Retrieve global styles tags: - global-styles parameters: - name: id in: path required: true schema: type: integer description: ID of global styles config. responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createGlobalStylesById summary: Create global styles tags: - global-styles parameters: - name: id in: path required: true schema: type: string description: Path parameter id declared by the route regex. requestBody: required: false content: application/json: schema: type: object properties: styles: type: object description: Global styles. settings: type: object description: Global settings. title: type: - object - string description: Title of the global styles variation. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/global-styles/{parent}/revisions: get: operationId: getGlobalStylesByParentRevisions summary: Retrieve global styles revisions tags: - global-styles parameters: - name: parent in: path required: true schema: type: integer description: The ID for the parent of the revision. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/global-styles/{parent}/revisions/{id}: get: operationId: getGlobalStylesByParentRevisionsById summary: Retrieve global styles revisions tags: - global-styles parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the global styles revision. - name: parent in: path required: true schema: type: integer description: The ID for the parent of the global styles revision. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/global-styles/themes/{stylesheet}/variations: get: operationId: getGlobalStylesThemesByStylesheetVariations summary: Retrieve global styles themes variations tags: - global-styles parameters: - name: stylesheet in: path required: true schema: type: string description: The theme identifier responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/global-styles/themes/{stylesheet}: get: operationId: getGlobalStylesThemesByStylesheet summary: Retrieve global styles themes tags: - global-styles parameters: - name: stylesheet in: path required: true schema: type: string description: The theme identifier responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/icons: get: operationId: listIcons summary: List icons tags: - icons parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 10 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/icons/{name}: get: operationId: getIconsByName summary: Retrieve icons tags: - icons parameters: - name: name in: path required: true schema: type: string description: Icon name. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/locations: get: operationId: listLocations summary: List locations tags: - locations parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 10 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: after schema: type: string format: date-time required: false description: Limit response to posts published after a given ISO8601 compliant date. in: query - name: modified_after schema: type: string format: date-time required: false description: Limit response to posts modified after a given ISO8601 compliant date. in: query - name: before schema: type: string format: date-time required: false description: Limit response to posts published before a given ISO8601 compliant date. in: query - name: modified_before schema: type: string format: date-time required: false description: Limit response to posts modified before a given ISO8601 compliant date. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: search_semantics schema: type: string enum: - exact required: false description: How to interpret the search input. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: desc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date required: false description: Sort collection by post attribute. in: query - name: search_columns schema: type: array default: [] items: type: string enum: - post_title - post_content - post_excerpt required: false description: Array of column names to be searched. in: query - name: slug schema: type: array items: type: string required: false description: Limit result set to posts with one or more specific slugs. in: query - name: status 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 - any required: false description: Limit result set to posts assigned one or more statuses. in: query - name: tax_relation schema: type: string enum: - AND - OR required: false description: Limit result set based on relationship between multiple taxonomies. in: query - name: states schema: type: - object - array required: false description: Limit result set to items with specific terms assigned in the states taxonomy. in: query - name: states_exclude schema: type: - object - array required: false description: Limit result set to items except those with specific terms assigned in the states taxonomy. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createLocations summary: Create locations tags: - locations requestBody: required: false content: application/json: schema: type: object properties: date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object description: The title for the post. content: type: object description: The content for the post. featured_media: type: integer description: The ID of the featured media for the post. template: type: string description: The theme file to use to display the post. states: type: array items: type: integer description: The terms assigned to the post in the states taxonomy. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/locations/{id}: get: operationId: getLocationsById summary: Retrieve locations tags: - locations parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: password schema: type: string required: false description: The password for the post if it is password protected. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createLocationsById summary: Create locations tags: - locations parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. requestBody: required: false content: application/json: schema: type: object properties: date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object description: The title for the post. content: type: object description: The content for the post. featured_media: type: integer description: The ID of the featured media for the post. template: type: string description: The theme file to use to display the post. states: type: array items: type: integer description: The terms assigned to the post in the states taxonomy. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteLocationsById summary: Delete locations tags: - locations parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. - name: force schema: type: boolean default: false required: false description: Whether to bypass Trash and force deletion. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/locations/{id}/autosaves: get: operationId: getLocationsByIdAutosaves summary: Retrieve locations autosaves tags: - locations parameters: - name: id in: path required: true schema: type: string description: Path parameter id declared by the route regex. - name: parent schema: type: integer required: false description: The ID for the parent of the autosave. in: query - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createLocationsByIdAutosaves summary: Create locations autosaves tags: - locations parameters: - name: id in: path required: true schema: type: string description: Path parameter id declared by the route regex. requestBody: required: false content: application/json: schema: type: object properties: parent: type: integer description: The ID for the parent of the autosave. date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object description: The title for the post. content: type: object description: The content for the post. featured_media: type: integer description: The ID of the featured media for the post. template: type: string description: The theme file to use to display the post. states: type: array items: type: integer description: The terms assigned to the post in the states taxonomy. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/locations/{parent}/autosaves/{id}: get: operationId: getLocationsByParentAutosavesById summary: Retrieve locations autosaves tags: - locations parameters: - name: id in: path required: true schema: type: integer description: The ID for the autosave. - name: parent in: path required: true schema: type: integer description: The ID for the parent of the autosave. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/media: get: operationId: listMedia summary: List media tags: - media parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 10 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: after schema: type: string format: date-time required: false description: Limit response to posts published after a given ISO8601 compliant date. in: query - name: modified_after schema: type: string format: date-time required: false description: Limit response to posts modified after a given ISO8601 compliant date. in: query - name: author schema: type: array default: [] items: type: integer required: false description: Limit result set to posts assigned to specific authors. in: query - name: author_exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes posts assigned to specific authors. in: query - name: before schema: type: string format: date-time required: false description: Limit response to posts published before a given ISO8601 compliant date. in: query - name: modified_before schema: type: string format: date-time required: false description: Limit response to posts modified before a given ISO8601 compliant date. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: search_semantics schema: type: string enum: - exact required: false description: How to interpret the search input. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: desc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date required: false description: Sort collection by post attribute. in: query - name: parent schema: type: array default: [] items: type: integer required: false description: Limit result set to items with particular parent IDs. in: query - name: parent_exclude schema: type: array default: [] items: type: integer required: false description: Limit result set to all items except those of a particular parent ID. in: query - name: search_columns schema: type: array default: [] items: type: string enum: - post_title - post_content - post_excerpt required: false description: Array of column names to be searched. in: query - name: slug schema: type: array items: type: string required: false description: Limit result set to posts with one or more specific slugs. in: query - name: status schema: type: array default: inherit items: type: string enum: - inherit - private - trash required: false description: Limit result set to posts assigned one or more statuses. in: query - name: media_type schema: type: array default: null items: type: string enum: - image - video - text - application - audio required: false description: Limit result set to attachments of a particular media type or media types. in: query - name: mime_type schema: type: array default: null items: type: string required: false description: Limit result set to attachments of a particular MIME type or MIME types. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createMedia summary: Create media tags: - media requestBody: required: false content: application/json: schema: type: object properties: date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. title: type: object description: The title for the post. author: type: integer description: The ID for the author of the post. featured_media: type: integer description: The ID of the featured media for the post. comment_status: type: string enum: - open - closed description: Whether or not comments are open on the post. ping_status: type: string enum: - open - closed description: Whether or not the post can be pinged. meta: type: object description: Meta fields. template: type: string description: The theme file to use to display the post. 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. post: type: integer description: The ID for the associated post of the attachment. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/media/{id}: get: operationId: getMediaById summary: Retrieve media tags: - media parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createMediaById summary: Create media tags: - media parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. requestBody: required: false content: application/json: schema: type: object properties: date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. title: type: object description: The title for the post. author: type: integer description: The ID for the author of the post. featured_media: type: integer description: The ID of the featured media for the post. comment_status: type: string enum: - open - closed description: Whether or not comments are open on the post. ping_status: type: string enum: - open - closed description: Whether or not the post can be pinged. meta: type: object description: Meta fields. template: type: string description: The theme file to use to display the post. 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. post: type: integer description: The ID for the associated post of the attachment. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteMediaById summary: Delete media tags: - media parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. - name: force schema: type: boolean default: false required: false description: Whether to bypass Trash and force deletion. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/media/{id}/edit: post: operationId: createMediaByIdEdit summary: Create media edit tags: - media parameters: - name: id in: path required: true schema: type: string description: Path parameter id declared by the route regex. requestBody: required: true content: application/json: schema: type: object properties: src: type: string format: uri description: URL to the edited image file. modifiers: type: array items: type: object description: Array of image edits. rotation: type: integer minimum: 0 maximum: 360 description: 'The amount to rotate the image clockwise in degrees. 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.' 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.' 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.' caption: type: object description: The attachment caption. description: type: object description: The attachment description. title: type: object description: The title for the post. post: type: integer description: The ID for the associated post of the attachment. alt_text: type: string description: Alternative text to display when attachment is not displayed. required: - src security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/media/{id}/post-process: post: operationId: createMediaByIdPostProcess summary: Create media post process tags: - media parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the attachment. requestBody: required: true content: application/json: schema: type: object properties: action: type: string enum: - create-image-subsizes required: - action security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/menu-items: get: operationId: listMenuItems summary: List menu items tags: - menu-items parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 100 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: after schema: type: string format: date-time required: false description: Limit response to posts published after a given ISO8601 compliant date. in: query - name: modified_after schema: type: string format: date-time required: false description: Limit response to posts modified after a given ISO8601 compliant date. in: query - name: before schema: type: string format: date-time required: false description: Limit response to posts published before a given ISO8601 compliant date. in: query - name: modified_before schema: type: string format: date-time required: false description: Limit response to posts modified before a given ISO8601 compliant date. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: search_semantics schema: type: string enum: - exact required: false description: How to interpret the search input. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: asc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title - menu_order default: menu_order required: false description: Sort collection by object attribute. in: query - name: search_columns schema: type: array default: [] items: type: string enum: - post_title - post_content - post_excerpt required: false description: Array of column names to be searched. in: query - name: slug schema: type: array items: type: string required: false description: Limit result set to posts with one or more specific slugs. in: query - name: status 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 - any required: false description: Limit result set to posts assigned one or more statuses. in: query - name: tax_relation schema: type: string enum: - AND - OR required: false description: Limit result set based on relationship between multiple taxonomies. in: query - name: menus schema: type: - object - array required: false description: Limit result set to items with specific terms assigned in the menus taxonomy. in: query - name: menus_exclude schema: type: - object - array required: false description: Limit result set to items except those with specific terms assigned in the menus taxonomy. in: query - name: menu_order schema: type: integer required: false description: Limit result set to posts with a specific menu_order value. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createMenuItems summary: Create menu items tags: - menu-items requestBody: required: false content: application/json: schema: type: object properties: title: type: - string - object 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". status: type: string enum: - publish - future - draft - pending - private - acf-disabled default: publish description: A named status for the object. parent: type: integer default: 0 minimum: 0 description: The ID for the parent of the object. 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. 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. target: type: string enum: - _blank - '' description: The target attribute of the link element for this menu item. 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. menus: type: integer description: The terms assigned to the object in the nav_menu taxonomy. meta: type: object description: Meta fields. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/menu-items/{id}: get: operationId: getMenuItemsById summary: Retrieve menu items tags: - menu-items parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createMenuItemsById summary: Create menu items tags: - menu-items parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. requestBody: required: false content: application/json: schema: type: object properties: title: type: - string - object 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". status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the object. parent: type: integer minimum: 0 description: The ID for the parent of the object. 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. 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. target: type: string enum: - _blank - '' description: The target attribute of the link element for this menu item. 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. menus: type: integer description: The terms assigned to the object in the nav_menu taxonomy. meta: type: object description: Meta fields. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteMenuItemsById summary: Delete menu items tags: - menu-items parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. - name: force schema: type: boolean default: false required: false description: Whether to bypass Trash and force deletion. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/menu-items/{id}/autosaves: get: operationId: getMenuItemsByIdAutosaves summary: Retrieve menu items autosaves tags: - menu-items parameters: - name: id in: path required: true schema: type: string description: Path parameter id declared by the route regex. - name: parent schema: type: integer required: false description: The ID for the parent of the autosave. in: query - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createMenuItemsByIdAutosaves summary: Create menu items autosaves tags: - menu-items parameters: - name: id in: path required: true schema: type: string description: Path parameter id declared by the route regex. requestBody: required: false content: application/json: schema: type: object properties: parent: type: integer minimum: 0 description: The ID for the parent of the object. title: type: - string - object 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". status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the object. 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. 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. target: type: string enum: - _blank - '' description: The target attribute of the link element for this menu item. 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. menus: type: integer description: The terms assigned to the object in the nav_menu taxonomy. meta: type: object description: Meta fields. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/menu-items/{parent}/autosaves/{id}: get: operationId: getMenuItemsByParentAutosavesById summary: Retrieve menu items autosaves tags: - menu-items parameters: - name: id in: path required: true schema: type: integer description: The ID for the autosave. - name: parent in: path required: true schema: type: integer description: The ID for the parent of the autosave. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/menu-locations: get: operationId: listMenuLocations summary: List menu locations tags: - menu-locations parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/menu-locations/{location}: get: operationId: getMenuLocationsByLocation summary: Retrieve menu locations tags: - menu-locations parameters: - name: location in: path required: true schema: type: string description: An alphanumeric identifier for the menu location. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/menus: get: operationId: listMenus summary: List menus tags: - menus parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 10 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: asc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name required: false description: Sort collection by term attribute. in: query - name: hide_empty schema: type: boolean default: false required: false description: Whether to hide terms not assigned to any posts. in: query - name: post schema: type: integer default: null required: false description: Limit result set to terms assigned to a specific post. in: query - name: slug schema: type: array items: type: string required: false description: Limit result set to terms with one or more specific slugs. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createMenus summary: Create menus tags: - menus requestBody: required: true content: application/json: schema: type: object properties: description: type: string description: HTML description of the term. name: type: string description: HTML title for the term. slug: type: string description: An alphanumeric identifier for the term unique to its type. meta: type: object description: Meta fields. locations: type: array items: type: string description: The locations assigned to the menu. auto_add: type: boolean description: Whether to automatically add top level pages to this menu. required: - name security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/menus/{id}: get: operationId: getMenusById summary: Retrieve menus tags: - menus parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the term. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createMenusById summary: Create menus tags: - menus parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the term. requestBody: required: false content: application/json: schema: type: object properties: description: type: string description: HTML description of the term. name: type: string description: HTML title for the term. slug: type: string description: An alphanumeric identifier for the term unique to its type. meta: type: object description: Meta fields. locations: type: array items: type: string description: The locations assigned to the menu. auto_add: type: boolean description: Whether to automatically add top level pages to this menu. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteMenusById summary: Delete menus tags: - menus parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the term. - name: force schema: type: boolean default: false required: false description: Required to be true, as terms do not support trashing. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/navigation: get: operationId: listNavigation summary: List navigation tags: - navigation parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 10 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: after schema: type: string format: date-time required: false description: Limit response to posts published after a given ISO8601 compliant date. in: query - name: modified_after schema: type: string format: date-time required: false description: Limit response to posts modified after a given ISO8601 compliant date. in: query - name: before schema: type: string format: date-time required: false description: Limit response to posts published before a given ISO8601 compliant date. in: query - name: modified_before schema: type: string format: date-time required: false description: Limit response to posts modified before a given ISO8601 compliant date. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: search_semantics schema: type: string enum: - exact required: false description: How to interpret the search input. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: desc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date required: false description: Sort collection by post attribute. in: query - name: search_columns schema: type: array default: [] items: type: string enum: - post_title - post_content - post_excerpt required: false description: Array of column names to be searched. in: query - name: slug schema: type: array items: type: string required: false description: Limit result set to posts with one or more specific slugs. in: query - name: status 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 - any required: false description: Limit result set to posts assigned one or more statuses. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createNavigation summary: Create navigation tags: - navigation requestBody: required: false content: application/json: schema: type: object properties: date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object description: The title for the post. content: type: object description: The content for the post. template: type: string description: The theme file to use to display the post. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/navigation/{id}: get: operationId: getNavigationById summary: Retrieve navigation tags: - navigation parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: password schema: type: string required: false description: The password for the post if it is password protected. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createNavigationById summary: Create navigation tags: - navigation parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. requestBody: required: false content: application/json: schema: type: object properties: date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object description: The title for the post. content: type: object description: The content for the post. template: type: string description: The theme file to use to display the post. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteNavigationById summary: Delete navigation tags: - navigation parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. - name: force schema: type: boolean default: false required: false description: Whether to bypass Trash and force deletion. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/navigation/{id}/autosaves: get: operationId: getNavigationByIdAutosaves summary: Retrieve navigation autosaves tags: - navigation parameters: - name: id in: path required: true schema: type: string description: Path parameter id declared by the route regex. - name: parent schema: type: integer required: false description: The ID for the parent of the autosave. in: query - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createNavigationByIdAutosaves summary: Create navigation autosaves tags: - navigation parameters: - name: id in: path required: true schema: type: string description: Path parameter id declared by the route regex. requestBody: required: false content: application/json: schema: type: object properties: parent: type: integer description: The ID for the parent of the autosave. date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object description: The title for the post. content: type: object description: The content for the post. template: type: string description: The theme file to use to display the post. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/navigation/{parent}/autosaves/{id}: get: operationId: getNavigationByParentAutosavesById summary: Retrieve navigation autosaves tags: - navigation parameters: - name: id in: path required: true schema: type: integer description: The ID for the autosave. - name: parent in: path required: true schema: type: integer description: The ID for the parent of the autosave. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/navigation/{parent}/revisions: get: operationId: getNavigationByParentRevisions summary: Retrieve navigation revisions tags: - navigation parameters: - name: parent in: path required: true schema: type: integer description: The ID for the parent of the revision. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: desc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date required: false description: Sort collection by object attribute. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/navigation/{parent}/revisions/{id}: get: operationId: getNavigationByParentRevisionsById summary: Retrieve navigation revisions tags: - navigation parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the revision. - name: parent in: path required: true schema: type: integer description: The ID for the parent of the revision. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteNavigationByParentRevisionsById summary: Delete navigation revisions tags: - navigation parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the revision. - name: parent in: path required: true schema: type: integer description: The ID for the parent of the revision. - name: force schema: type: boolean default: false required: false description: Required to be true, as revisions do not support trashing. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/pages: get: operationId: listPages summary: List pages tags: - pages parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 10 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: after schema: type: string format: date-time required: false description: Limit response to posts published after a given ISO8601 compliant date. in: query - name: modified_after schema: type: string format: date-time required: false description: Limit response to posts modified after a given ISO8601 compliant date. in: query - name: author schema: type: array default: [] items: type: integer required: false description: Limit result set to posts assigned to specific authors. in: query - name: author_exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes posts assigned to specific authors. in: query - name: before schema: type: string format: date-time required: false description: Limit response to posts published before a given ISO8601 compliant date. in: query - name: modified_before schema: type: string format: date-time required: false description: Limit response to posts modified before a given ISO8601 compliant date. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: menu_order schema: type: integer required: false description: Limit result set to posts with a specific menu_order value. in: query - name: search_semantics schema: type: string enum: - exact required: false description: How to interpret the search input. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: desc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title - menu_order default: date required: false description: Sort collection by post attribute. in: query - name: parent schema: type: array default: [] items: type: integer required: false description: Limit result set to items with particular parent IDs. in: query - name: parent_exclude schema: type: array default: [] items: type: integer required: false description: Limit result set to all items except those of a particular parent ID. in: query - name: search_columns schema: type: array default: [] items: type: string enum: - post_title - post_content - post_excerpt required: false description: Array of column names to be searched. in: query - name: slug schema: type: array items: type: string required: false description: Limit result set to posts with one or more specific slugs. in: query - name: status 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 - any required: false description: Limit result set to posts assigned one or more statuses. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createPages summary: Create pages tags: - pages requestBody: required: false content: application/json: schema: type: object properties: date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. parent: type: integer description: The ID for the parent of the post. title: type: object description: The title for the post. content: type: object description: The content for the post. author: type: integer description: The ID for the author of the post. excerpt: type: object description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. comment_status: type: string enum: - open - closed description: Whether or not comments are open on the post. ping_status: type: string enum: - open - closed description: Whether or not the post can be pinged. menu_order: type: integer description: The order of the post in relation to other posts. meta: type: object description: Meta fields. template: type: string description: The theme file to use to display the post. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/pages/{id}: get: operationId: getPagesById summary: Retrieve pages tags: - pages parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: excerpt_length schema: type: integer required: false description: Override the default excerpt length. in: query - name: password schema: type: string required: false description: The password for the post if it is password protected. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createPagesById summary: Create pages tags: - pages parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. requestBody: required: false content: application/json: schema: type: object properties: date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. parent: type: integer description: The ID for the parent of the post. title: type: object description: The title for the post. content: type: object description: The content for the post. author: type: integer description: The ID for the author of the post. excerpt: type: object description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. comment_status: type: string enum: - open - closed description: Whether or not comments are open on the post. ping_status: type: string enum: - open - closed description: Whether or not the post can be pinged. menu_order: type: integer description: The order of the post in relation to other posts. meta: type: object description: Meta fields. template: type: string description: The theme file to use to display the post. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deletePagesById summary: Delete pages tags: - pages parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. - name: force schema: type: boolean default: false required: false description: Whether to bypass Trash and force deletion. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/pages/{id}/autosaves: get: operationId: getPagesByIdAutosaves summary: Retrieve pages autosaves tags: - pages parameters: - name: id in: path required: true schema: type: string description: Path parameter id declared by the route regex. - name: parent schema: type: integer required: false description: The ID for the parent of the autosave. in: query - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createPagesByIdAutosaves summary: Create pages autosaves tags: - pages parameters: - name: id in: path required: true schema: type: string description: Path parameter id declared by the route regex. requestBody: required: false content: application/json: schema: type: object properties: parent: type: integer description: The ID for the parent of 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. 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. password: type: string description: A password to protect access to the content and excerpt. title: type: object description: The title for the post. content: type: object description: The content for the post. author: type: integer description: The ID for the author of the post. excerpt: type: object description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. comment_status: type: string enum: - open - closed description: Whether or not comments are open on the post. ping_status: type: string enum: - open - closed description: Whether or not the post can be pinged. menu_order: type: integer description: The order of the post in relation to other posts. meta: type: object description: Meta fields. template: type: string description: The theme file to use to display the post. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/pages/{parent}/autosaves/{id}: get: operationId: getPagesByParentAutosavesById summary: Retrieve pages autosaves tags: - pages parameters: - name: id in: path required: true schema: type: integer description: The ID for the autosave. - name: parent in: path required: true schema: type: integer description: The ID for the parent of the autosave. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/pages/{parent}/revisions: get: operationId: getPagesByParentRevisions summary: Retrieve pages revisions tags: - pages parameters: - name: parent in: path required: true schema: type: integer description: The ID for the parent of the revision. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: desc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date required: false description: Sort collection by object attribute. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/pages/{parent}/revisions/{id}: get: operationId: getPagesByParentRevisionsById summary: Retrieve pages revisions tags: - pages parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the revision. - name: parent in: path required: true schema: type: integer description: The ID for the parent of the revision. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deletePagesByParentRevisionsById summary: Delete pages revisions tags: - pages parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the revision. - name: parent in: path required: true schema: type: integer description: The ID for the parent of the revision. - name: force schema: type: boolean default: false required: false description: Required to be true, as revisions do not support trashing. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/pattern-directory/patterns: get: operationId: listPatternDirectoryPatterns summary: List pattern directory patterns tags: - pattern-directory parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 100 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string minLength: 1 required: false description: Limit results to those matching a string. in: query - name: category schema: type: integer minimum: 1 required: false description: Limit results to those matching a category ID. in: query - name: keyword schema: type: integer minimum: 1 required: false description: Limit results to those matching a keyword ID. in: query - name: slug schema: type: array items: type: string required: false description: Limit results to those matching a pattern (slug). in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: desc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title - favorite_count default: date required: false description: Sort collection by post attribute. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/plugins: get: operationId: listPlugins summary: List plugins tags: - plugins parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: status schema: type: array items: type: string enum: - inactive - active required: false description: Limits results to plugins with the given status. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createPlugins summary: Create 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 security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/plugins/{plugin}: get: operationId: getPluginsByPlugin summary: Retrieve plugins tags: - plugins parameters: - name: plugin in: path required: true schema: type: string description: Path parameter plugin declared by the route regex. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createPluginsByPlugin summary: Create plugins tags: - plugins parameters: - name: plugin in: path required: true schema: type: string description: Path parameter plugin declared by the route regex. 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. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deletePluginsByPlugin summary: Delete plugins tags: - plugins parameters: - name: plugin in: path required: true schema: type: string description: Path parameter plugin declared by the route regex. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/posts: get: operationId: listPosts summary: List posts tags: - posts parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 10 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: after schema: type: string format: date-time required: false description: Limit response to posts published after a given ISO8601 compliant date. in: query - name: modified_after schema: type: string format: date-time required: false description: Limit response to posts modified after a given ISO8601 compliant date. in: query - name: author schema: type: array default: [] items: type: integer required: false description: Limit result set to posts assigned to specific authors. in: query - name: author_exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes posts assigned to specific authors. in: query - name: before schema: type: string format: date-time required: false description: Limit response to posts published before a given ISO8601 compliant date. in: query - name: modified_before schema: type: string format: date-time required: false description: Limit response to posts modified before a given ISO8601 compliant date. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: search_semantics schema: type: string enum: - exact required: false description: How to interpret the search input. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: desc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date required: false description: Sort collection by post attribute. in: query - name: search_columns schema: type: array default: [] items: type: string enum: - post_title - post_content - post_excerpt required: false description: Array of column names to be searched. in: query - name: slug schema: type: array items: type: string required: false description: Limit result set to posts with one or more specific slugs. in: query - name: status 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 - any required: false description: Limit result set to posts assigned one or more statuses. in: query - name: tax_relation schema: type: string enum: - AND - OR required: false description: Limit result set based on relationship between multiple taxonomies. in: query - name: categories schema: type: - object - array required: false description: Limit result set to items with specific terms assigned in the categories taxonomy. in: query - name: categories_exclude schema: type: - object - array required: false description: Limit result set to items except those with specific terms assigned in the categories taxonomy. in: query - name: tags schema: type: - object - array required: false description: Limit result set to items with specific terms assigned in the tags taxonomy. in: query - name: tags_exclude schema: type: - object - array required: false description: Limit result set to items except those with specific terms assigned in the tags taxonomy. in: query - name: sticky schema: type: boolean required: false description: Limit result set to items that are sticky. in: query - name: ignore_sticky schema: type: boolean default: true required: false description: Whether to ignore sticky posts or not. in: query - name: format schema: type: array items: type: string enum: - standard - aside - chat - gallery - link - image - quote - status - video - audio required: false description: Limit result set to items assigned one or more given formats. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createPosts summary: Create posts tags: - posts requestBody: required: false content: application/json: schema: type: object properties: date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object description: The title for the post. content: type: object description: The content for the post. author: type: integer description: The ID for the author of the post. excerpt: type: object description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. comment_status: type: string enum: - open - closed description: Whether or not comments are open on the post. ping_status: type: string enum: - open - closed description: Whether or not the post can be pinged. 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. sticky: type: boolean description: Whether or not the post should be treated as sticky. template: type: string description: The theme file to use to display the post. categories: type: array items: type: integer description: The terms assigned to the post in the category taxonomy. tags: type: array items: type: integer description: The terms assigned to the post in the post_tag taxonomy. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/posts/{id}: get: operationId: getPostsById summary: Retrieve posts tags: - posts parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: excerpt_length schema: type: integer required: false description: Override the default excerpt length. in: query - name: password schema: type: string required: false description: The password for the post if it is password protected. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createPostsById summary: Create posts tags: - posts parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. requestBody: required: false content: application/json: schema: type: object properties: date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object description: The title for the post. content: type: object description: The content for the post. author: type: integer description: The ID for the author of the post. excerpt: type: object description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. comment_status: type: string enum: - open - closed description: Whether or not comments are open on the post. ping_status: type: string enum: - open - closed description: Whether or not the post can be pinged. 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. sticky: type: boolean description: Whether or not the post should be treated as sticky. template: type: string description: The theme file to use to display the post. categories: type: array items: type: integer description: The terms assigned to the post in the category taxonomy. tags: type: array items: type: integer description: The terms assigned to the post in the post_tag taxonomy. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deletePostsById summary: Delete posts tags: - posts parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. - name: force schema: type: boolean default: false required: false description: Whether to bypass Trash and force deletion. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/posts/{id}/autosaves: get: operationId: getPostsByIdAutosaves summary: Retrieve posts autosaves tags: - posts parameters: - name: id in: path required: true schema: type: string description: Path parameter id declared by the route regex. - name: parent schema: type: integer required: false description: The ID for the parent of the autosave. in: query - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createPostsByIdAutosaves summary: Create posts autosaves tags: - posts parameters: - name: id in: path required: true schema: type: string description: Path parameter id declared by the route regex. requestBody: required: false content: application/json: schema: type: object properties: parent: type: integer description: The ID for the parent of the autosave. date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object description: The title for the post. content: type: object description: The content for the post. author: type: integer description: The ID for the author of the post. excerpt: type: object description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. comment_status: type: string enum: - open - closed description: Whether or not comments are open on the post. ping_status: type: string enum: - open - closed description: Whether or not the post can be pinged. 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. sticky: type: boolean description: Whether or not the post should be treated as sticky. template: type: string description: The theme file to use to display the post. categories: type: array items: type: integer description: The terms assigned to the post in the category taxonomy. tags: type: array items: type: integer description: The terms assigned to the post in the post_tag taxonomy. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/posts/{parent}/autosaves/{id}: get: operationId: getPostsByParentAutosavesById summary: Retrieve posts autosaves tags: - posts parameters: - name: id in: path required: true schema: type: integer description: The ID for the autosave. - name: parent in: path required: true schema: type: integer description: The ID for the parent of the autosave. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/posts/{parent}/revisions: get: operationId: getPostsByParentRevisions summary: Retrieve posts revisions tags: - posts parameters: - name: parent in: path required: true schema: type: integer description: The ID for the parent of the revision. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: desc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date required: false description: Sort collection by object attribute. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/posts/{parent}/revisions/{id}: get: operationId: getPostsByParentRevisionsById summary: Retrieve posts revisions tags: - posts parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the revision. - name: parent in: path required: true schema: type: integer description: The ID for the parent of the revision. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deletePostsByParentRevisionsById summary: Delete posts revisions tags: - posts parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the revision. - name: parent in: path required: true schema: type: integer description: The ID for the parent of the revision. - name: force schema: type: boolean default: false required: false description: Required to be true, as revisions do not support trashing. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/review: get: operationId: listReview summary: List review tags: - review parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 10 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: after schema: type: string format: date-time required: false description: Limit response to posts published after a given ISO8601 compliant date. in: query - name: modified_after schema: type: string format: date-time required: false description: Limit response to posts modified after a given ISO8601 compliant date. in: query - name: author schema: type: array default: [] items: type: integer required: false description: Limit result set to posts assigned to specific authors. in: query - name: author_exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes posts assigned to specific authors. in: query - name: before schema: type: string format: date-time required: false description: Limit response to posts published before a given ISO8601 compliant date. in: query - name: modified_before schema: type: string format: date-time required: false description: Limit response to posts modified before a given ISO8601 compliant date. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: search_semantics schema: type: string enum: - exact required: false description: How to interpret the search input. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: desc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date required: false description: Sort collection by post attribute. in: query - name: search_columns schema: type: array default: [] items: type: string enum: - post_title - post_content - post_excerpt required: false description: Array of column names to be searched. in: query - name: slug schema: type: array items: type: string required: false description: Limit result set to posts with one or more specific slugs. in: query - name: status 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 - any required: false description: Limit result set to posts assigned one or more statuses. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createReview summary: Create review tags: - review requestBody: required: false content: application/json: schema: type: object properties: date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object description: The title for the post. content: type: object description: The content for the post. author: type: integer description: The ID for the author of the post. excerpt: type: object description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. template: type: string description: The theme file to use to display the post. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/review/{id}: get: operationId: getReviewById summary: Retrieve review tags: - review parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: excerpt_length schema: type: integer required: false description: Override the default excerpt length. in: query - name: password schema: type: string required: false description: The password for the post if it is password protected. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createReviewById summary: Create review tags: - review parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. requestBody: required: false content: application/json: schema: type: object properties: date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object description: The title for the post. content: type: object description: The content for the post. author: type: integer description: The ID for the author of the post. excerpt: type: object description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. template: type: string description: The theme file to use to display the post. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteReviewById summary: Delete review tags: - review parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the post. - name: force schema: type: boolean default: false required: false description: Whether to bypass Trash and force deletion. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/review/{id}/autosaves: get: operationId: getReviewByIdAutosaves summary: Retrieve review autosaves tags: - review parameters: - name: id in: path required: true schema: type: string description: Path parameter id declared by the route regex. - name: parent schema: type: integer required: false description: The ID for the parent of the autosave. in: query - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createReviewByIdAutosaves summary: Create review autosaves tags: - review parameters: - name: id in: path required: true schema: type: string description: Path parameter id declared by the route regex. requestBody: required: false content: application/json: schema: type: object properties: parent: type: integer description: The ID for the parent of the autosave. date: type: string format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: string format: date-time description: The date the post was published, as GMT. slug: type: string description: An alphanumeric identifier for the post unique to its type. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object description: The title for the post. content: type: object description: The content for the post. author: type: integer description: The ID for the author of the post. excerpt: type: object description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. template: type: string description: The theme file to use to display the post. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/review/{parent}/autosaves/{id}: get: operationId: getReviewByParentAutosavesById summary: Retrieve review autosaves tags: - review parameters: - name: id in: path required: true schema: type: integer description: The ID for the autosave. - name: parent in: path required: true schema: type: integer description: The ID for the parent of the autosave. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/search: get: operationId: listSearch summary: List search tags: - search parameters: - name: context schema: type: string enum: - view - embed default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 10 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: type schema: type: string enum: - post - term - post-format default: post required: false description: Limit results to items of an object type. in: query - name: subtype schema: type: array default: any items: type: string enum: - post - page - e-floating-buttons - elementor_library - review - locations - category - post_tag - states - any required: false description: Limit results to items of one or more object subtypes. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/settings: get: operationId: listSettings summary: List settings tags: - settings responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createSettings summary: Create settings tags: - settings requestBody: required: false content: application/json: schema: type: object properties: genesis_blocks_mailchimp_api_key: type: string title: type: string description: Site title. description: type: string description: Site tagline. url: type: string format: uri description: Site URL. email: type: string format: email description: This address is used for admin purposes, like new user notification. timezone: type: string description: A city in the same timezone as you. date_format: type: string description: A date format for all date strings. time_format: type: string description: A time format for all time strings. start_of_week: type: integer description: A day number of the week that the week should start on. language: type: string description: WordPress locale code. use_smilies: type: boolean description: Convert emoticons like :-) and :-P to graphics on display. default_category: type: integer description: Default post category. default_post_format: type: string description: Default post format. posts_per_page: type: integer description: Blog pages show at most. show_on_front: type: string description: What to show on the front page page_on_front: type: integer description: The ID of the page that should be displayed on the front page page_for_posts: type: integer description: The ID of the page that should display the latest posts default_ping_status: type: string enum: - open - closed description: Allow link notifications from other blogs (pingbacks and trackbacks) on new articles. default_comment_status: type: string enum: - open - closed description: Allow people to submit comments on new posts. site_logo: type: integer description: Site logo. site_icon: type: integer description: Site icon. elementor_one_welcome_screen_completed: type: boolean description: Elementor One Welcome Screen Completed elementor_one_dismiss_connect_alert: type: boolean description: Elementor One Dismiss Connect Alert security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/sidebars: get: operationId: listSidebars summary: List sidebars tags: - sidebars parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/sidebars/{id}: get: operationId: getSidebarsById summary: Retrieve sidebars tags: - sidebars parameters: - name: id in: path required: true schema: type: string description: The id of a registered sidebar - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createSidebarsById summary: Create sidebars tags: - sidebars parameters: - name: id in: path required: true schema: type: string description: Path parameter id declared by the route regex. requestBody: required: false content: application/json: schema: type: object properties: widgets: type: array items: type: - object - string description: Nested widgets. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/states: get: operationId: listStates summary: List states tags: - states parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 10 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: order schema: type: string enum: - asc - desc default: asc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name required: false description: Sort collection by term attribute. in: query - name: hide_empty schema: type: boolean default: false required: false description: Whether to hide terms not assigned to any posts. in: query - name: parent schema: type: integer required: false description: Limit result set to terms assigned to a specific parent. in: query - name: post schema: type: integer default: null required: false description: Limit result set to terms assigned to a specific post. in: query - name: slug schema: type: array items: type: string required: false description: Limit result set to terms with one or more specific slugs. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createStates summary: Create states tags: - states requestBody: required: true content: application/json: schema: type: object properties: description: type: string description: HTML description of the term. name: type: string description: HTML title for the term. slug: type: string description: An alphanumeric identifier for the term unique to its type. parent: type: integer description: The parent term ID. meta: type: object description: Meta fields. required: - name security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/states/{id}: get: operationId: getStatesById summary: Retrieve states tags: - states parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the term. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createStatesById summary: Create states tags: - states parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the term. requestBody: required: false content: application/json: schema: type: object properties: description: type: string description: HTML description of the term. name: type: string description: HTML title for the term. slug: type: string description: An alphanumeric identifier for the term unique to its type. parent: type: integer description: The parent term ID. meta: type: object description: Meta fields. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteStatesById summary: Delete states tags: - states parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the term. - name: force schema: type: boolean default: false required: false description: Required to be true, as terms do not support trashing. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/statuses: get: operationId: listStatuses summary: List statuses tags: - statuses parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/statuses/{status}: get: operationId: getStatusesByStatus summary: Retrieve statuses tags: - statuses parameters: - name: status in: path required: true schema: type: string description: An alphanumeric identifier for the status. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/tags: get: operationId: listTags summary: List tags tags: - tags parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 10 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: asc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name required: false description: Sort collection by term attribute. in: query - name: hide_empty schema: type: boolean default: false required: false description: Whether to hide terms not assigned to any posts. in: query - name: post schema: type: integer default: null required: false description: Limit result set to terms assigned to a specific post. in: query - name: slug schema: type: array items: type: string required: false description: Limit result set to terms with one or more specific slugs. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createTags summary: Create tags tags: - tags requestBody: required: true content: application/json: schema: type: object properties: description: type: string description: HTML description of the term. name: type: string description: HTML title for the term. slug: type: string description: An alphanumeric identifier for the term unique to its type. meta: type: object description: Meta fields. required: - name security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/tags/{id}: get: operationId: getTagsById summary: Retrieve tags tags: - tags parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the term. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createTagsById summary: Create tags tags: - tags parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the term. requestBody: required: false content: application/json: schema: type: object properties: description: type: string description: HTML description of the term. name: type: string description: HTML title for the term. slug: type: string description: An alphanumeric identifier for the term unique to its type. meta: type: object description: Meta fields. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteTagsById summary: Delete tags tags: - tags parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the term. - name: force schema: type: boolean default: false required: false description: Required to be true, as terms do not support trashing. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/taxonomies: get: operationId: listTaxonomies summary: List taxonomies tags: - taxonomies parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: type schema: type: string required: false description: Limit results to taxonomies associated with a specific post type. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/taxonomies/{taxonomy}: get: operationId: getTaxonomiesByTaxonomy summary: Retrieve taxonomies tags: - taxonomies parameters: - name: taxonomy in: path required: true schema: type: string description: An alphanumeric identifier for the taxonomy. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/template-parts: get: operationId: listTemplateParts summary: List template parts tags: - template-parts parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: wp_id schema: type: integer required: false description: Limit to the specified post id. in: query - name: area schema: type: string required: false description: Limit to the specified template part area. in: query - name: post_type schema: type: string required: false description: Post type to get the templates for. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createTemplateParts summary: Create template parts tags: - template-parts requestBody: required: true content: application/json: schema: type: object properties: slug: type: string minLength: 1 description: Unique slug identifying the template. theme: type: string description: Theme identifier for the template. type: type: string description: Type of template. content: type: - object - string default: '' description: Content of template. title: type: - object - string default: '' description: Title of template. description: type: string default: '' description: Description of template. status: type: string enum: - publish - future - draft - pending - private - acf-disabled default: publish description: Status of template. author: type: integer description: The ID for the author of the template. area: type: string description: Where the template part is intended for use (header, footer, etc.) required: - slug security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/template-parts/{id}: get: operationId: getTemplatePartsById summary: Retrieve template parts tags: - template-parts parameters: - name: id in: path required: true schema: type: string description: The id of a template - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createTemplatePartsById summary: Create template parts tags: - template-parts parameters: - name: id in: path required: true schema: type: string description: The id of a template requestBody: required: false content: application/json: schema: type: object properties: slug: type: string minLength: 1 description: Unique slug identifying the template. theme: type: string description: Theme identifier for the template. type: type: string description: Type of template. content: type: - object - string description: Content of template. title: type: - object - string description: Title of template. description: type: string description: Description of template. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: Status of template. author: type: integer description: The ID for the author of the template. area: type: string description: Where the template part is intended for use (header, footer, etc.) security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteTemplatePartsById summary: Delete template parts tags: - template-parts parameters: - name: id in: path required: true schema: type: string description: The id of a template - name: force schema: type: boolean default: false required: false description: Whether to bypass Trash and force deletion. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/template-parts/{id}/autosaves: get: operationId: getTemplatePartsByIdAutosaves summary: Retrieve template parts autosaves tags: - template-parts parameters: - name: id in: path required: true schema: type: string description: The id of a template - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createTemplatePartsByIdAutosaves summary: Create template parts autosaves tags: - template-parts parameters: - name: id in: path required: true schema: type: string description: The id of a template requestBody: required: false content: application/json: schema: type: object properties: slug: type: string minLength: 1 description: Unique slug identifying the template. theme: type: string description: Theme identifier for the template. type: type: string description: Type of template. content: type: - object - string description: Content of template. title: type: - object - string description: Title of template. description: type: string description: Description of template. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: Status of template. author: type: integer description: The ID for the author of the template. area: type: string description: Where the template part is intended for use (header, footer, etc.) security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/template-parts/{parent}/autosaves/{id}: get: operationId: getTemplatePartsByParentAutosavesById summary: Retrieve template parts autosaves tags: - template-parts parameters: - name: id in: path required: true schema: type: integer description: The ID for the autosave. - name: parent in: path required: true schema: type: string description: The id of a template - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/template-parts/{parent}/revisions: get: operationId: getTemplatePartsByParentRevisions summary: Retrieve template parts revisions tags: - template-parts parameters: - name: parent in: path required: true schema: type: string description: The id of a template - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: desc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date required: false description: Sort collection by object attribute. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/template-parts/{parent}/revisions/{id}: get: operationId: getTemplatePartsByParentRevisionsById summary: Retrieve template parts revisions tags: - template-parts parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the revision. - name: parent in: path required: true schema: type: string description: The id of a template - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteTemplatePartsByParentRevisionsById summary: Delete template parts revisions tags: - template-parts parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the revision. - name: parent in: path required: true schema: type: string description: The id of a template - name: force schema: type: boolean default: false required: false description: Required to be true, as revisions do not support trashing. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/template-parts/lookup: get: operationId: listTemplatePartsLookup summary: List template parts lookup tags: - template-parts parameters: - name: slug schema: type: string required: true description: The slug of the template to get the fallback for in: query - name: is_custom schema: type: boolean required: false description: Indicates if a template is custom or part of the template hierarchy in: query - name: template_prefix schema: type: string required: false 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` in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/templates: get: operationId: listTemplates summary: List templates tags: - templates parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: wp_id schema: type: integer required: false description: Limit to the specified post id. in: query - name: area schema: type: string required: false description: Limit to the specified template part area. in: query - name: post_type schema: type: string required: false description: Post type to get the templates for. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createTemplates summary: Create templates tags: - templates requestBody: required: true content: application/json: schema: type: object properties: slug: type: string minLength: 1 description: Unique slug identifying the template. theme: type: string description: Theme identifier for the template. type: type: string description: Type of template. content: type: - object - string default: '' description: Content of template. title: type: - object - string default: '' description: Title of template. description: type: string default: '' description: Description of template. status: type: string enum: - publish - future - draft - pending - private - acf-disabled default: publish description: Status of template. author: type: integer description: The ID for the author of the template. required: - slug security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/templates/{id}: get: operationId: getTemplatesById summary: Retrieve templates tags: - templates parameters: - name: id in: path required: true schema: type: string description: The id of a template - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createTemplatesById summary: Create templates tags: - templates parameters: - name: id in: path required: true schema: type: string description: The id of a template requestBody: required: false content: application/json: schema: type: object properties: slug: type: string minLength: 1 description: Unique slug identifying the template. theme: type: string description: Theme identifier for the template. type: type: string description: Type of template. content: type: - object - string description: Content of template. title: type: - object - string description: Title of template. description: type: string description: Description of template. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: Status of template. author: type: integer description: The ID for the author of the template. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteTemplatesById summary: Delete templates tags: - templates parameters: - name: id in: path required: true schema: type: string description: The id of a template - name: force schema: type: boolean default: false required: false description: Whether to bypass Trash and force deletion. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/templates/{id}/autosaves: get: operationId: getTemplatesByIdAutosaves summary: Retrieve templates autosaves tags: - templates parameters: - name: id in: path required: true schema: type: string description: The id of a template - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createTemplatesByIdAutosaves summary: Create templates autosaves tags: - templates parameters: - name: id in: path required: true schema: type: string description: The id of a template requestBody: required: false content: application/json: schema: type: object properties: slug: type: string minLength: 1 description: Unique slug identifying the template. theme: type: string description: Theme identifier for the template. type: type: string description: Type of template. content: type: - object - string description: Content of template. title: type: - object - string description: Title of template. description: type: string description: Description of template. status: type: string enum: - publish - future - draft - pending - private - acf-disabled description: Status of template. author: type: integer description: The ID for the author of the template. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/templates/{parent}/autosaves/{id}: get: operationId: getTemplatesByParentAutosavesById summary: Retrieve templates autosaves tags: - templates parameters: - name: id in: path required: true schema: type: integer description: The ID for the autosave. - name: parent in: path required: true schema: type: string description: The id of a template - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/templates/{parent}/revisions: get: operationId: getTemplatesByParentRevisions summary: Retrieve templates revisions tags: - templates parameters: - name: parent in: path required: true schema: type: string description: The id of a template - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: desc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date required: false description: Sort collection by object attribute. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/templates/{parent}/revisions/{id}: get: operationId: getTemplatesByParentRevisionsById summary: Retrieve templates revisions tags: - templates parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the revision. - name: parent in: path required: true schema: type: string description: The id of a template - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteTemplatesByParentRevisionsById summary: Delete templates revisions tags: - templates parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the revision. - name: parent in: path required: true schema: type: string description: The id of a template - name: force schema: type: boolean default: false required: false description: Required to be true, as revisions do not support trashing. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/templates/lookup: get: operationId: listTemplatesLookup summary: List templates lookup tags: - templates parameters: - name: slug schema: type: string required: true description: The slug of the template to get the fallback for in: query - name: is_custom schema: type: boolean required: false description: Indicates if a template is custom or part of the template hierarchy in: query - name: template_prefix schema: type: string required: false 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` in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/themes: get: operationId: listThemes summary: List themes tags: - themes parameters: - name: status schema: type: array items: type: string enum: - active - inactive required: false description: Limit result set to themes assigned one or more statuses. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/themes/{stylesheet}: get: operationId: getThemesByStylesheet summary: Retrieve themes tags: - themes parameters: - name: stylesheet in: path required: true schema: type: string description: The theme's stylesheet. This uniquely identifies the theme. responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/types: get: operationId: listTypes summary: List types tags: - types parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/types/{type}: get: operationId: getTypesByType summary: Retrieve types tags: - types parameters: - name: type in: path required: true schema: type: string description: An alphanumeric identifier for the post type. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/users: get: operationId: listUsers summary: List users tags: - users parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 10 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: asc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - id - include - name - registered_date - slug - include_slugs - email - url default: name required: false description: Sort collection by user attribute. in: query - name: slug schema: type: array items: type: string required: false description: Limit result set to users with one or more specific slugs. in: query - name: roles schema: type: array items: type: string required: false description: Limit result set to users matching at least one specific role provided. Accepts csv list or single role. in: query - name: capabilities schema: type: array items: type: string required: false description: Limit result set to users matching at least one specific capability provided. Accepts csv list or single capability. in: query - name: who schema: type: string enum: - authors required: false description: Limit result set to users who are considered authors. in: query - name: has_published_posts schema: type: - boolean - array items: type: string enum: post: post page: page attachment: attachment nav_menu_item: nav_menu_item wp_block: wp_block wp_template: wp_template wp_template_part: wp_template_part wp_global_styles: wp_global_styles wp_navigation: wp_navigation wp_font_family: wp_font_family wp_font_face: wp_font_face e-floating-buttons: e-floating-buttons elementor_library: elementor_library elementor_snippet: elementor_snippet review: review locations: locations required: false description: Limit result set to users who have published posts. in: query - name: search_columns schema: type: array default: [] items: type: string enum: - email - name - id - username - slug required: false description: Array of column names to be searched. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createUsers summary: Create users tags: - users requestBody: required: true content: application/json: schema: type: object properties: username: type: string description: Login name for the user. name: type: string description: Display name for the user. first_name: type: string description: First name for the user. last_name: type: string description: Last name for the user. email: type: string format: email description: The email address for the user. url: type: string format: uri description: URL of the user. description: type: string description: Description of the user. locale: type: string enum: - '' - en_US description: Locale for the user. nickname: type: string description: The nickname for the user. slug: type: string description: An alphanumeric identifier for the user. roles: type: array items: type: string description: Roles assigned to the user. password: type: string description: Password for the user (never included). meta: type: object description: Meta fields. elementor_introduction: type: object description: Elementor user meta data required: - username - email - password security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/users/{id}: get: operationId: getUsersById summary: Retrieve users tags: - users parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the user. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createUsersById summary: Create users tags: - users parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the user. requestBody: required: false content: application/json: schema: type: object properties: username: type: string description: Login name for the user. name: type: string description: Display name for the user. first_name: type: string description: First name for the user. last_name: type: string description: Last name for the user. email: type: string format: email description: The email address for the user. url: type: string format: uri description: URL of the user. description: type: string description: Description of the user. locale: type: string enum: - '' - en_US description: Locale for the user. nickname: type: string description: The nickname for the user. slug: type: string description: An alphanumeric identifier for the user. roles: type: array items: type: string description: Roles assigned to the user. password: type: string description: Password for the user (never included). meta: type: object description: Meta fields. elementor_introduction: type: object description: Elementor user meta data security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteUsersById summary: Delete users tags: - users parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the user. - name: force schema: type: boolean default: false required: false description: Required to be true, as users do not support trashing. in: query - name: reassign schema: type: integer required: true description: Reassign the deleted user's posts and links to this user ID. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/users/{user_id}/application-passwords: get: operationId: getUsersByUser_IdApplicationPasswords summary: Retrieve users application passwords tags: - users parameters: - name: user_id in: path required: true schema: type: string description: Path parameter user_id declared by the route regex. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createUsersByUser_IdApplicationPasswords summary: Create users application passwords tags: - users parameters: - name: user_id in: path required: true schema: type: string description: Path parameter user_id declared by the route regex. 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 minLength: 1 description: The name of the application password. required: - name security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteUsersByUser_IdApplicationPasswords summary: Delete users application passwords tags: - users parameters: - name: user_id in: path required: true schema: type: string description: Path parameter user_id declared by the route regex. responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/users/{user_id}/application-passwords/{uuid}: get: operationId: getUsersByUser_IdApplicationPasswordsByUuid summary: Retrieve users application passwords tags: - users parameters: - name: uuid in: path required: true schema: type: string description: Path parameter uuid declared by the route regex. - name: user_id in: path required: true schema: type: string description: Path parameter user_id declared by the route regex. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createUsersByUser_IdApplicationPasswordsByUuid summary: Create users application passwords tags: - users parameters: - name: uuid in: path required: true schema: type: string description: Path parameter uuid declared by the route regex. - name: user_id in: path required: true schema: type: string description: Path parameter user_id declared by the route regex. 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 minLength: 1 description: The name of the application password. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteUsersByUser_IdApplicationPasswordsByUuid summary: Delete users application passwords tags: - users parameters: - name: uuid in: path required: true schema: type: string description: Path parameter uuid declared by the route regex. - name: user_id in: path required: true schema: type: string description: Path parameter user_id declared by the route regex. responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/users/{user_id}/application-passwords/introspect: get: operationId: getUsersByUser_IdApplicationPasswordsIntrospect summary: Retrieve users application passwords introspect tags: - users parameters: - name: user_id in: path required: true schema: type: string description: Path parameter user_id declared by the route regex. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/users/me: get: operationId: listUsersMe summary: List users me tags: - users parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createUsersMe summary: Create users me tags: - users requestBody: required: false content: application/json: schema: type: object properties: username: type: string description: Login name for the user. name: type: string description: Display name for the user. first_name: type: string description: First name for the user. last_name: type: string description: Last name for the user. email: type: string format: email description: The email address for the user. url: type: string format: uri description: URL of the user. description: type: string description: Description of the user. locale: type: string enum: - '' - en_US description: Locale for the user. nickname: type: string description: The nickname for the user. slug: type: string description: An alphanumeric identifier for the user. roles: type: array items: type: string description: Roles assigned to the user. password: type: string description: Password for the user (never included). meta: type: object description: Meta fields. elementor_introduction: type: object description: Elementor user meta data security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteUsersMe summary: Delete users me tags: - users parameters: - name: force schema: type: boolean default: false required: false description: Required to be true, as users do not support trashing. in: query - name: reassign schema: type: integer required: true description: Reassign the deleted user's posts and links to this user ID. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/widget-types: get: operationId: listWidgetTypes summary: List widget types tags: - widget-types parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/widget-types/{id}: get: operationId: getWidgetTypesById summary: Retrieve widget types tags: - widget-types parameters: - name: id in: path required: true schema: type: string description: The widget type id. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/widget-types/{id}/encode: post: operationId: createWidgetTypesByIdEncode summary: Create widget types encode tags: - widget-types parameters: - name: id in: path required: true schema: type: string description: The widget type id. requestBody: required: false content: application/json: schema: type: object properties: instance: type: object description: Current instance settings of the widget. form_data: type: string description: Serialized widget form data to encode into instance settings. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/widget-types/{id}/render: post: operationId: createWidgetTypesByIdRender summary: Create widget types render tags: - widget-types parameters: - name: id in: path required: true schema: type: string description: The widget type id. requestBody: required: false content: application/json: schema: type: object properties: instance: type: object description: Current instance settings of the widget. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/widgets: get: operationId: listWidgets summary: List widgets tags: - widgets parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: sidebar schema: type: string required: false description: The sidebar to return widgets for. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createWidgets summary: Create widgets tags: - widgets requestBody: required: true content: application/json: schema: type: object properties: 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. sidebar: type: string default: wp_inactive_widgets description: The sidebar the widget belongs to. instance: type: object description: Instance settings of the widget, if supported. 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. required: - sidebar security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/widgets/{id}: get: operationId: getWidgetsById summary: Retrieve widgets tags: - widgets parameters: - name: id in: path required: true schema: type: string description: Path parameter id declared by the route regex. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createWidgetsById summary: Create widgets tags: - widgets parameters: - name: id in: path required: true schema: type: string description: Unique identifier for the widget. requestBody: required: false content: application/json: schema: type: object properties: id_base: type: string description: The type of the widget. Corresponds to ID in widget-types endpoint. sidebar: type: string description: The sidebar the widget belongs to. instance: type: object description: Instance settings of the widget, if supported. 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. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteWidgetsById summary: Delete widgets tags: - widgets parameters: - name: id in: path required: true schema: type: string description: Path parameter id declared by the route regex. - name: force schema: type: boolean required: false description: Whether to force removal of the widget, or move it to the inactive sidebar. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/wp_pattern_category: get: operationId: listWpPatternCategory summary: List wp pattern category tags: - wp_pattern_category parameters: - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query - name: page schema: type: integer default: 1 minimum: 1 required: false description: Current page of the collection. in: query - name: per_page schema: type: integer default: 10 minimum: 1 maximum: 100 required: false description: Maximum number of items to be returned in result set. in: query - name: search schema: type: string required: false description: Limit results to those matching a string. in: query - name: exclude schema: type: array default: [] items: type: integer required: false description: Ensure result set excludes specific IDs. in: query - name: include schema: type: array default: [] items: type: integer required: false description: Limit result set to specific IDs. in: query - name: offset schema: type: integer required: false description: Offset the result set by a specific number of items. in: query - name: order schema: type: string enum: - asc - desc default: asc required: false description: Order sort attribute ascending or descending. in: query - name: orderby schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name required: false description: Sort collection by term attribute. in: query - name: hide_empty schema: type: boolean default: false required: false description: Whether to hide terms not assigned to any posts. in: query - name: post schema: type: integer default: null required: false description: Limit result set to terms assigned to a specific post. in: query - name: slug schema: type: array items: type: string required: false description: Limit result set to terms with one or more specific slugs. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createWpPatternCategory summary: Create 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. name: type: string description: HTML title for the term. slug: type: string description: An alphanumeric identifier for the term unique to its type. meta: type: object description: Meta fields. required: - name security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 /wp/v2/wp_pattern_category/{id}: get: operationId: getWpPatternCategoryById summary: Retrieve wp pattern category tags: - wp_pattern_category parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the term. - name: context schema: type: string enum: - view - embed - edit default: view required: false description: Scope under which the request is made; determines fields present in response. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 post: operationId: createWpPatternCategoryById summary: Create wp pattern category tags: - wp_pattern_category parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the term. requestBody: required: false content: application/json: schema: type: object properties: description: type: string description: HTML description of the term. name: type: string description: HTML title for the term. slug: type: string description: An alphanumeric identifier for the term unique to its type. meta: type: object description: Meta fields. security: - applicationPasswords: [] responses: '200': description: Successful response. content: application/json: schema: type: object '201': description: Resource created. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003 delete: operationId: deleteWpPatternCategoryById summary: Delete wp pattern category tags: - wp_pattern_category parameters: - name: id in: path required: true schema: type: integer description: Unique identifier for the term. - name: force schema: type: boolean default: false required: false description: Required to be true, as terms do not support trashing. in: query responses: '200': description: Successful response. content: application/json: schema: type: object '400': *id001 '401': *id002 '404': *id003