openapi: 3.1.0 info: title: Endeavor BioMedicines WordPress REST API version: wp/v2 description: Machine-readable description of the public WordPress REST API served by endeavorbiomedicines.com. DERIVED mechanically from the route index the site itself publishes at https://endeavorbiomedicines.com/wp-json/ on 2026-08-12 — every path, method, argument, default and enum below is taken verbatim from that document. Only WordPress-core namespaces are included (wp/v2, oembed/1.0, wp-abilities/v1, mcp, wp-site-health/v1, wp-block-editor/v1); third-party plugin namespaces present on the same host are listed in x-excluded-namespaces. Content read operations (posts, pages, media, taxonomies, types) answer anonymously; write and administrative operations require WordPress authentication. This is a site-platform API, not a product API — Endeavor BioMedicines publishes no developer program. contact: name: Endeavor BioMedicines url: https://endeavorbiomedicines.com/contact/ servers: - url: https://endeavorbiomedicines.com/wp-json x-derived-from: https://endeavorbiomedicines.com/wp-json/ x-derived-on: '2026-08-12' x-excluded-namespaces: (root): 2 ajaxselect2/v1: 2 cky/v1: 36 duplicate-post/v1: 2 redirection/v1: 32 sliderrevolution: 7 wordfence-login-security/v1: 3 wordfence/v1: 7 wp-rocket/v1: 17 wp-toolkit/api: 3 yoast/v1: 59 tags: - name: mcp - name: oembed/1.0 - name: wp-abilities/v1 - name: wp-block-editor/v1 - name: wp-site-health/v1 - name: wp/v2 paths: /mcp: get: operationId: getMcp summary: GET /mcp tags: - mcp parameters: - name: namespace in: query required: false schema: type: string default: mcp - name: context in: query required: false schema: type: string default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /mcp/mcp-adapter-default-server: post: operationId: postMcpMcpadapterdefaultserver summary: POST /mcp/mcp-adapter-default-server tags: - mcp responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' get: operationId: getMcpMcpadapterdefaultserver summary: GET /mcp/mcp-adapter-default-server tags: - mcp responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteMcpMcpadapterdefaultserver summary: DELETE /mcp/mcp-adapter-default-server tags: - mcp responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /mcp/mcp-oauth-server: post: operationId: postMcpMcpoauthserver summary: POST /mcp/mcp-oauth-server tags: - mcp responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' get: operationId: getMcpMcpoauthserver summary: GET /mcp/mcp-oauth-server tags: - mcp responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteMcpMcpoauthserver summary: DELETE /mcp/mcp-oauth-server tags: - mcp responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /oembed/1.0: get: operationId: getOembed10 summary: GET /oembed/1.0 tags: - oembed/1.0 parameters: - name: namespace in: query required: false schema: type: string default: oembed/1.0 - name: context in: query required: false schema: type: string default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /oembed/1.0/embed: get: operationId: getOembed10Embed summary: GET /oembed/1.0/embed tags: - oembed/1.0 parameters: - name: url in: query required: true schema: type: string format: uri description: The URL of the resource for which to fetch oEmbed data. - name: format in: query required: false schema: type: string default: json - name: maxwidth in: query required: false schema: type: string default: 600 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /oembed/1.0/proxy: get: operationId: getOembed10Proxy summary: GET /oembed/1.0/proxy tags: - oembed/1.0 parameters: - name: url in: query required: true schema: type: string format: uri description: The URL of the resource for which to fetch oEmbed data. - name: format in: query required: false schema: type: string enum: - json - xml default: json description: The oEmbed format to use. - name: maxwidth in: query required: false schema: type: integer default: 600 description: The maximum width of the embed frame in pixels. - name: maxheight in: query required: false schema: type: integer description: The maximum height of the embed frame in pixels. - name: discover in: query required: false schema: type: boolean default: true description: Whether to perform an oEmbed discovery request for unsanctioned providers. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp-abilities/v1: get: operationId: getWpabilitiesV1 summary: GET /wp-abilities/v1 tags: - wp-abilities/v1 parameters: - name: namespace in: query required: false schema: type: string default: wp-abilities/v1 - name: context in: query required: false schema: type: string default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp-abilities/v1/abilities: get: operationId: getWpabilitiesV1Abilities summary: GET /wp-abilities/v1/abilities tags: - wp-abilities/v1 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 50 description: Maximum number of items to be returned in result set. - name: category in: query required: false schema: type: string description: Limit results to abilities in specific ability category. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp-abilities/v1/abilities/{name}/]+): parameters: - name: name in: path required: true schema: type: string get: operationId: getWpabilitiesV1AbilitiesByName summary: GET /wp-abilities/v1/abilities/{name}/]+) tags: - wp-abilities/v1 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp-abilities/v1/abilities/{name}/]+?)/run: parameters: - name: name in: path required: true schema: type: string get: operationId: getWpabilitiesV1AbilitiesByNameRun summary: GET /wp-abilities/v1/abilities/{name}/]+?)/run tags: - wp-abilities/v1 parameters: - name: input in: query required: false schema: type: integer description: Input parameters for the ability execution. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpabilitiesV1AbilitiesByNameRun summary: POST /wp-abilities/v1/abilities/{name}/]+?)/run tags: - wp-abilities/v1 requestBody: required: false content: application/json: schema: type: object properties: input: type: integer description: Input parameters for the ability execution. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpabilitiesV1AbilitiesByNameRun summary: PUT /wp-abilities/v1/abilities/{name}/]+?)/run tags: - wp-abilities/v1 requestBody: required: false content: application/json: schema: type: object properties: input: type: integer description: Input parameters for the ability execution. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpabilitiesV1AbilitiesByNameRun summary: PATCH /wp-abilities/v1/abilities/{name}/]+?)/run tags: - wp-abilities/v1 requestBody: required: false content: application/json: schema: type: object properties: input: type: integer description: Input parameters for the ability execution. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpabilitiesV1AbilitiesByNameRun summary: DELETE /wp-abilities/v1/abilities/{name}/]+?)/run tags: - wp-abilities/v1 parameters: - name: input in: query required: false schema: type: integer description: Input parameters for the ability execution. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp-abilities/v1/categories: get: operationId: getWpabilitiesV1Categories summary: GET /wp-abilities/v1/categories tags: - wp-abilities/v1 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 50 description: Maximum number of items to be returned in result set. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp-abilities/v1/categories/{slug}: parameters: - name: slug in: path required: true schema: type: string get: operationId: getWpabilitiesV1CategoriesBySlug summary: GET /wp-abilities/v1/categories/{slug} tags: - wp-abilities/v1 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp-block-editor/v1: get: operationId: getWpblockeditorV1 summary: GET /wp-block-editor/v1 tags: - wp-block-editor/v1 parameters: - name: namespace in: query required: false schema: type: string default: wp-block-editor/v1 - name: context in: query required: false schema: type: string default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp-block-editor/v1/export: get: operationId: getWpblockeditorV1Export summary: GET /wp-block-editor/v1/export tags: - wp-block-editor/v1 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp-block-editor/v1/navigation-fallback: get: operationId: getWpblockeditorV1Navigationfallback summary: GET /wp-block-editor/v1/navigation-fallback tags: - wp-block-editor/v1 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp-block-editor/v1/url-details: get: operationId: getWpblockeditorV1Urldetails summary: GET /wp-block-editor/v1/url-details tags: - wp-block-editor/v1 parameters: - name: url in: query required: true schema: type: string format: uri description: The URL to process. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp-site-health/v1: get: operationId: getWpsitehealthV1 summary: GET /wp-site-health/v1 tags: - wp-site-health/v1 parameters: - name: namespace in: query required: false schema: type: string default: wp-site-health/v1 - name: context in: query required: false schema: type: string default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp-site-health/v1/directory-sizes: get: operationId: getWpsitehealthV1Directorysizes summary: GET /wp-site-health/v1/directory-sizes tags: - wp-site-health/v1 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp-site-health/v1/tests/authorization-header: get: operationId: getWpsitehealthV1TestsAuthorizationheader summary: GET /wp-site-health/v1/tests/authorization-header tags: - wp-site-health/v1 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp-site-health/v1/tests/background-updates: get: operationId: getWpsitehealthV1TestsBackgroundupdates summary: GET /wp-site-health/v1/tests/background-updates tags: - wp-site-health/v1 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp-site-health/v1/tests/dotorg-communication: get: operationId: getWpsitehealthV1TestsDotorgcommunication summary: GET /wp-site-health/v1/tests/dotorg-communication tags: - wp-site-health/v1 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp-site-health/v1/tests/https-status: get: operationId: getWpsitehealthV1TestsHttpsstatus summary: GET /wp-site-health/v1/tests/https-status tags: - wp-site-health/v1 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp-site-health/v1/tests/loopback-requests: get: operationId: getWpsitehealthV1TestsLoopbackrequests summary: GET /wp-site-health/v1/tests/loopback-requests tags: - wp-site-health/v1 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp-site-health/v1/tests/page-cache: get: operationId: getWpsitehealthV1TestsPagecache summary: GET /wp-site-health/v1/tests/page-cache tags: - wp-site-health/v1 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2: get: operationId: getWpV2 summary: GET /wp/v2 tags: - wp/v2 parameters: - name: namespace in: query required: false schema: type: string default: wp/v2 - name: context in: query required: false schema: type: string default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/block-directory/search: get: operationId: getWpV2BlockdirectorySearch summary: GET /wp/v2/block-directory/search tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: term in: query required: true schema: type: string description: Limit result set to blocks matching the search term. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/block-patterns/categories: get: operationId: getWpV2BlockpatternsCategories summary: GET /wp/v2/block-patterns/categories tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/block-patterns/patterns: get: operationId: getWpV2BlockpatternsPatterns summary: GET /wp/v2/block-patterns/patterns tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/block-renderer/{name}/[a-z0-9-]+): parameters: - name: name in: path required: true schema: type: string get: operationId: getWpV2BlockrendererByNameaz09 summary: GET /wp/v2/block-renderer/{name}/[a-z0-9-]+) tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: &id001 - edit default: view description: Scope under which the request is made; determines fields present in response. - name: attributes in: query required: false schema: type: object default: &id002 [] description: Attributes for the block. - name: post_id in: query required: false schema: type: integer description: ID of the post context. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2BlockrendererByNameaz09 summary: POST /wp/v2/block-renderer/{name}/[a-z0-9-]+) tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: context: type: string enum: *id001 default: view description: Scope under which the request is made; determines fields present in response. attributes: type: object default: *id002 description: Attributes for the block. post_id: type: integer description: ID of the post context. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/block-types: get: operationId: getWpV2Blocktypes summary: GET /wp/v2/block-types tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: namespace in: query required: false schema: type: string description: Block namespace. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/block-types/{namespace}: parameters: - name: namespace in: path required: true schema: type: string get: operationId: getWpV2BlocktypesByNamespace summary: GET /wp/v2/block-types/{namespace} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/block-types/{namespace}/{name}: parameters: - name: namespace in: path required: true schema: type: string - name: name in: path required: true schema: type: string get: operationId: getWpV2BlocktypesByNamespaceByName summary: GET /wp/v2/block-types/{namespace}/{name} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/blocks: get: operationId: getWpV2Blocks summary: GET /wp/v2/blocks tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: modified_after in: query required: false schema: type: string format: date-time description: Limit response to posts modified after a given ISO8601 compliant date. - name: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - name: modified_before in: query required: false schema: type: string format: date-time description: Limit response to posts modified before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date description: Sort collection by post attribute. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. - name: status in: query required: false schema: type: array default: publish items: type: string description: Limit result set to posts assigned one or more statuses. - name: tax_relation in: query required: false schema: type: string enum: - AND - OR description: Limit result set based on relationship between multiple taxonomies. - name: wp_pattern_category in: query required: false schema: type: object description: Limit result set to items with specific terms assigned in the wp_pattern_category taxonomy. - name: wp_pattern_category_exclude in: query required: false schema: type: object description: Limit result set to items except those with specific terms assigned in the wp_pattern_category taxonomy. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2Blocks summary: POST /wp/v2/blocks tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/blocks/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2BlocksById summary: GET /wp/v2/blocks/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: excerpt_length in: query required: false schema: type: integer description: Override the default excerpt length. - name: password in: query required: false schema: type: string description: The password for the post if it is password protected. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2BlocksById summary: POST /wp/v2/blocks/{id} tags: - wp/v2 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: &id003 - 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2BlocksById summary: PUT /wp/v2/blocks/{id} tags: - wp/v2 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: *id003 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2BlocksById summary: PATCH /wp/v2/blocks/{id} tags: - wp/v2 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: *id003 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2BlocksById summary: DELETE /wp/v2/blocks/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/blocks/{id}/autosaves: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2BlocksByIdAutosaves summary: GET /wp/v2/blocks/{id}/autosaves tags: - wp/v2 parameters: - name: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2BlocksByIdAutosaves summary: POST /wp/v2/blocks/{id}/autosaves tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/blocks/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2BlocksByParentAutosavesById summary: GET /wp/v2/blocks/{parent}/autosaves/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/blocks/{parent}/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: getWpV2BlocksByParentRevisions summary: GET /wp/v2/blocks/{parent}/revisions tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date description: Sort collection by object attribute. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/blocks/{parent}/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2BlocksByParentRevisionsById summary: GET /wp/v2/blocks/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2BlocksByParentRevisionsById summary: DELETE /wp/v2/blocks/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as revisions do not support trashing. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/categories: get: operationId: getWpV2Categories summary: GET /wp/v2/categories tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: order in: query required: false schema: type: string enum: - asc - desc default: asc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name description: Sort collection by term attribute. - name: hide_empty in: query required: false schema: type: boolean default: false description: Whether to hide terms not assigned to any posts. - name: parent in: query required: false schema: type: integer description: Limit result set to terms assigned to a specific parent. - name: post in: query required: false schema: type: integer description: Limit result set to terms assigned to a specific post. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to terms with one or more specific slugs. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2Categories summary: POST /wp/v2/categories tags: - wp/v2 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/categories/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2CategoriesById summary: GET /wp/v2/categories/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2CategoriesById summary: POST /wp/v2/categories/{id} tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2CategoriesById summary: PUT /wp/v2/categories/{id} tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2CategoriesById summary: PATCH /wp/v2/categories/{id} tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2CategoriesById summary: DELETE /wp/v2/categories/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as terms do not support trashing. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/comments: get: operationId: getWpV2Comments summary: GET /wp/v2/comments tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to comments published after a given ISO8601 compliant date. - name: author in: query required: false schema: type: array items: type: integer description: Limit result set to comments assigned to specific user IDs. Requires authorization. - name: author_exclude in: query required: false schema: type: array items: type: integer description: Ensure result set excludes comments assigned to specific user IDs. Requires authorization. - name: author_email in: query required: false schema: type: string format: email description: Limit result set to that from a specific author email. Requires authorization. - name: before in: query required: false schema: type: string format: date-time description: Limit response to comments published before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - date - date_gmt - id - include - post - parent - type default: date_gmt description: Sort collection by comment attribute. - name: parent in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to comments of specific parent IDs. - name: parent_exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific parent IDs. - name: post in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to comments assigned to specific post IDs. - name: status in: query required: false schema: type: string default: approve description: Limit result set to comments assigned a specific status. Requires authorization. - name: type in: query required: false schema: type: string default: comment description: Limit result set to comments assigned a specific type. Requires authorization. - name: password in: query required: false schema: type: string description: The password for the post if it is password protected. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2Comments summary: POST /wp/v2/comments tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/comments/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2CommentsById summary: GET /wp/v2/comments/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: password in: query required: false schema: type: string description: The password for the parent post of the comment (if the post is password protected). responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2CommentsById summary: POST /wp/v2/comments/{id} tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2CommentsById summary: PUT /wp/v2/comments/{id} tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2CommentsById summary: PATCH /wp/v2/comments/{id} tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2CommentsById summary: DELETE /wp/v2/comments/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. - name: password in: query required: false schema: type: string description: The password for the parent post of the comment (if the post is password protected). responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/font-collections: get: operationId: getWpV2Fontcollections summary: GET /wp/v2/font-collections tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/font-collections/{slug}/\w-]+): parameters: - name: slug in: path required: true schema: type: string get: operationId: getWpV2FontcollectionsBySlugw summary: GET /wp/v2/font-collections/{slug}/\w-]+) tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/font-families: get: operationId: getWpV2Fontfamilies summary: GET /wp/v2/font-families tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - id - include default: id description: Sort collection by post attribute. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2Fontfamilies summary: POST /wp/v2/font-families tags: - wp/v2 requestBody: required: true content: application/json: schema: type: object properties: theme_json_version: type: integer default: 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/font-families/{font_family_id}/font-faces: parameters: - name: font_family_id in: path required: true schema: type: string get: operationId: getWpV2FontfamiliesByFontFamilyIdFontfaces summary: GET /wp/v2/font-families/{font_family_id}/font-faces tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - id - include default: id description: Sort collection by post attribute. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2FontfamiliesByFontFamilyIdFontfaces summary: POST /wp/v2/font-families/{font_family_id}/font-faces tags: - wp/v2 requestBody: required: true content: application/json: schema: type: object properties: theme_json_version: type: integer default: 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/font-families/{font_family_id}/font-faces/{id}: parameters: - name: font_family_id in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2FontfamiliesByFontFamilyIdFontfacesById summary: GET /wp/v2/font-families/{font_family_id}/font-faces/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2FontfamiliesByFontFamilyIdFontfacesById summary: DELETE /wp/v2/font-families/{font_family_id}/font-faces/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/font-families/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2FontfamiliesById summary: GET /wp/v2/font-families/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2FontfamiliesById summary: POST /wp/v2/font-families/{id} tags: - wp/v2 requestBody: required: true content: application/json: schema: type: object properties: theme_json_version: type: integer default: 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2FontfamiliesById summary: PUT /wp/v2/font-families/{id} tags: - wp/v2 requestBody: required: true content: application/json: schema: type: object properties: theme_json_version: type: integer default: 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2FontfamiliesById summary: PATCH /wp/v2/font-families/{id} tags: - wp/v2 requestBody: required: true content: application/json: schema: type: object properties: theme_json_version: type: integer default: 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2FontfamiliesById summary: DELETE /wp/v2/font-families/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/global-styles/{id}/\d+]+): parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2GlobalstylesByIdd summary: GET /wp/v2/global-styles/{id}/\d+]+) tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2GlobalstylesByIdd summary: POST /wp/v2/global-styles/{id}/\d+]+) tags: - wp/v2 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 description: Title of the global styles variation. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2GlobalstylesByIdd summary: PUT /wp/v2/global-styles/{id}/\d+]+) tags: - wp/v2 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 description: Title of the global styles variation. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2GlobalstylesByIdd summary: PATCH /wp/v2/global-styles/{id}/\d+]+) tags: - wp/v2 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 description: Title of the global styles variation. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/global-styles/{parent}/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: getWpV2GlobalstylesByParentRevisions summary: GET /wp/v2/global-styles/{parent}/revisions tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer description: Maximum number of items to be returned in result set. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/global-styles/{parent}/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2GlobalstylesByParentRevisionsById summary: GET /wp/v2/global-styles/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/global-styles/themes/{stylesheet}/\s%\w\.\(\)\[\]\@_\-]+)/variations: parameters: - name: stylesheet in: path required: true schema: type: string get: operationId: getWpV2GlobalstylesThemesByStylesheetswVariations summary: GET /wp/v2/global-styles/themes/{stylesheet}/\s%\w\.\(\)\[\]\@_\-]+)/variations tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/global-styles/themes/{stylesheet}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?): parameters: - name: stylesheet in: path required: true schema: type: string get: operationId: getWpV2GlobalstylesThemesByStylesheet summary: GET /wp/v2/global-styles/themes/{stylesheet}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?) tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/icons: get: operationId: getWpV2Icons summary: GET /wp/v2/icons tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/icons/{name}/[a-z][a-z0-9-]*): parameters: - name: name in: path required: true schema: type: string get: operationId: getWpV2IconsByNameazaz09 summary: GET /wp/v2/icons/{name}/[a-z][a-z0-9-]*) tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/media: get: operationId: getWpV2Media summary: GET /wp/v2/media tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: modified_after in: query required: false schema: type: string format: date-time description: Limit response to posts modified after a given ISO8601 compliant date. - name: author in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to posts assigned to specific authors. - name: author_exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes posts assigned to specific authors. - name: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - name: modified_before in: query required: false schema: type: string format: date-time description: Limit response to posts modified before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date description: Sort collection by post attribute. - name: parent in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to items with particular parent IDs. - name: parent_exclude in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to all items except those of a particular parent ID. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. - name: status in: query required: false schema: type: array default: inherit items: type: string description: Limit result set to posts assigned one or more statuses. - name: media_type in: query required: false schema: type: array items: type: string description: Limit result set to attachments of a particular media type or media types. - name: mime_type in: query required: false schema: type: array items: type: string description: Limit result set to attachments of a particular MIME type or MIME types. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2Media summary: POST /wp/v2/media tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/media/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2MediaById summary: GET /wp/v2/media/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2MediaById summary: POST /wp/v2/media/{id} tags: - wp/v2 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: &id004 - 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: &id005 - open - closed description: Whether or not comments are open on the post. ping_status: type: string enum: &id006 - 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2MediaById summary: PUT /wp/v2/media/{id} tags: - wp/v2 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: *id004 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: *id005 description: Whether or not comments are open on the post. ping_status: type: string enum: *id006 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2MediaById summary: PATCH /wp/v2/media/{id} tags: - wp/v2 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: *id004 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: *id005 description: Whether or not comments are open on the post. ping_status: type: string enum: *id006 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2MediaById summary: DELETE /wp/v2/media/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/media/{id}/edit: parameters: - name: id in: path required: true schema: type: string post: operationId: postWpV2MediaByIdEdit summary: POST /wp/v2/media/{id}/edit tags: - wp/v2 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 description: 'The amount to rotate the image clockwise in degrees. DEPRECATED: Use `modifiers` instead.' x: type: number description: 'As a percentage of the image, the x position to start the crop from. DEPRECATED: Use `modifiers` instead.' y: type: number description: 'As a percentage of the image, the y position to start the crop from. DEPRECATED: Use `modifiers` instead.' width: type: number description: 'As a percentage of the image, the width to crop the image to. DEPRECATED: Use `modifiers` instead.' height: type: number 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/media/{id}/post-process: parameters: - name: id in: path required: true schema: type: string post: operationId: postWpV2MediaByIdPostprocess summary: POST /wp/v2/media/{id}/post-process tags: - wp/v2 requestBody: required: true content: application/json: schema: type: object properties: action: type: string enum: - create-image-subsizes required: - action responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/member: get: operationId: getWpV2Member summary: GET /wp/v2/member tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: modified_after in: query required: false schema: type: string format: date-time description: Limit response to posts modified after a given ISO8601 compliant date. - name: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - name: modified_before in: query required: false schema: type: string format: date-time description: Limit response to posts modified before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: menu_order in: query required: false schema: type: integer description: Limit result set to posts with a specific menu_order value. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title - menu_order default: date description: Sort collection by post attribute. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. - name: status in: query required: false schema: type: array default: publish items: type: string description: Limit result set to posts assigned one or more statuses. - name: tax_relation in: query required: false schema: type: string enum: - AND - OR description: Limit result set based on relationship between multiple taxonomies. - name: member_cat in: query required: false schema: type: object description: Limit result set to items with specific terms assigned in the member_cat taxonomy. - name: member_cat_exclude in: query required: false schema: type: object description: Limit result set to items except those with specific terms assigned in the member_cat taxonomy. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2Member summary: POST /wp/v2/member tags: - wp/v2 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. featured_media: type: integer description: The ID of the featured media for the post. menu_order: type: integer description: The order of the post in relation to other posts. template: type: string description: The theme file to use to display the post. member_cat: type: array items: type: integer description: The terms assigned to the post in the member_cat taxonomy. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/member/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2MemberById summary: GET /wp/v2/member/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: excerpt_length in: query required: false schema: type: integer description: Override the default excerpt length. - name: password in: query required: false schema: type: string description: The password for the post if it is password protected. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2MemberById summary: POST /wp/v2/member/{id} tags: - wp/v2 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: &id007 - 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. featured_media: type: integer description: The ID of the featured media for the post. menu_order: type: integer description: The order of the post in relation to other posts. template: type: string description: The theme file to use to display the post. member_cat: type: array items: type: integer description: The terms assigned to the post in the member_cat taxonomy. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2MemberById summary: PUT /wp/v2/member/{id} tags: - wp/v2 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: *id007 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. featured_media: type: integer description: The ID of the featured media for the post. menu_order: type: integer description: The order of the post in relation to other posts. template: type: string description: The theme file to use to display the post. member_cat: type: array items: type: integer description: The terms assigned to the post in the member_cat taxonomy. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2MemberById summary: PATCH /wp/v2/member/{id} tags: - wp/v2 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: *id007 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. featured_media: type: integer description: The ID of the featured media for the post. menu_order: type: integer description: The order of the post in relation to other posts. template: type: string description: The theme file to use to display the post. member_cat: type: array items: type: integer description: The terms assigned to the post in the member_cat taxonomy. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2MemberById summary: DELETE /wp/v2/member/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/member/{id}/autosaves: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2MemberByIdAutosaves summary: GET /wp/v2/member/{id}/autosaves tags: - wp/v2 parameters: - name: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2MemberByIdAutosaves summary: POST /wp/v2/member/{id}/autosaves tags: - wp/v2 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. featured_media: type: integer description: The ID of the featured media for the post. menu_order: type: integer description: The order of the post in relation to other posts. template: type: string description: The theme file to use to display the post. member_cat: type: array items: type: integer description: The terms assigned to the post in the member_cat taxonomy. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/member/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2MemberByParentAutosavesById summary: GET /wp/v2/member/{parent}/autosaves/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/member_cat: get: operationId: getWpV2MemberCat summary: GET /wp/v2/member_cat tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: order in: query required: false schema: type: string enum: - asc - desc default: asc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name description: Sort collection by term attribute. - name: hide_empty in: query required: false schema: type: boolean default: false description: Whether to hide terms not assigned to any posts. - name: parent in: query required: false schema: type: integer description: Limit result set to terms assigned to a specific parent. - name: post in: query required: false schema: type: integer description: Limit result set to terms assigned to a specific post. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to terms with one or more specific slugs. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2MemberCat summary: POST /wp/v2/member_cat tags: - wp/v2 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/member_cat/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2MemberCatById summary: GET /wp/v2/member_cat/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2MemberCatById summary: POST /wp/v2/member_cat/{id} tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2MemberCatById summary: PUT /wp/v2/member_cat/{id} tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2MemberCatById summary: PATCH /wp/v2/member_cat/{id} tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2MemberCatById summary: DELETE /wp/v2/member_cat/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as terms do not support trashing. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/menu-items: get: operationId: getWpV2Menuitems summary: GET /wp/v2/menu-items tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 100 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: modified_after in: query required: false schema: type: string format: date-time description: Limit response to posts modified after a given ISO8601 compliant date. - name: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - name: modified_before in: query required: false schema: type: string format: date-time description: Limit response to posts modified before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: asc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title - menu_order default: menu_order description: Sort collection by object attribute. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. - name: status in: query required: false schema: type: array default: publish items: type: string description: Limit result set to posts assigned one or more statuses. - name: tax_relation in: query required: false schema: type: string enum: - AND - OR description: Limit result set based on relationship between multiple taxonomies. - name: menus in: query required: false schema: type: object description: Limit result set to items with specific terms assigned in the menus taxonomy. - name: menus_exclude in: query required: false schema: type: object description: Limit result set to items except those with specific terms assigned in the menus taxonomy. - name: menu_order in: query required: false schema: type: integer description: Limit result set to posts with a specific menu_order value. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2Menuitems summary: POST /wp/v2/menu-items tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: title: type: string description: The title for the object. type: type: string enum: - taxonomy - post_type - post_type_archive - custom default: custom description: The family of objects originally represented, such as "post_type" or "taxonomy". 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 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 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 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/menu-items/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2MenuitemsById summary: GET /wp/v2/menu-items/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2MenuitemsById summary: POST /wp/v2/menu-items/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: title: type: string description: The title for the object. type: type: string enum: &id008 - taxonomy - post_type - post_type_archive - custom description: The family of objects originally represented, such as "post_type" or "taxonomy". status: type: string enum: &id009 - publish - future - draft - pending - private - acf-disabled description: A named status for the object. parent: type: integer 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 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 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: &id010 - _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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2MenuitemsById summary: PUT /wp/v2/menu-items/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: title: type: string description: The title for the object. type: type: string enum: *id008 description: The family of objects originally represented, such as "post_type" or "taxonomy". status: type: string enum: *id009 description: A named status for the object. parent: type: integer 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 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 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: *id010 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2MenuitemsById summary: PATCH /wp/v2/menu-items/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: title: type: string description: The title for the object. type: type: string enum: *id008 description: The family of objects originally represented, such as "post_type" or "taxonomy". status: type: string enum: *id009 description: A named status for the object. parent: type: integer 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 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 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: *id010 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2MenuitemsById summary: DELETE /wp/v2/menu-items/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/menu-items/{id}/autosaves: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2MenuitemsByIdAutosaves summary: GET /wp/v2/menu-items/{id}/autosaves tags: - wp/v2 parameters: - name: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2MenuitemsByIdAutosaves summary: POST /wp/v2/menu-items/{id}/autosaves tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: parent: type: integer description: The ID for the parent of the object. title: type: string description: The title for the object. type: type: string enum: - taxonomy - post_type - post_type_archive - custom description: The family of objects originally represented, such as "post_type" or "taxonomy". 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 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 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/menu-items/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2MenuitemsByParentAutosavesById summary: GET /wp/v2/menu-items/{parent}/autosaves/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/menu-locations: get: operationId: getWpV2Menulocations summary: GET /wp/v2/menu-locations tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/menu-locations/{location}: parameters: - name: location in: path required: true schema: type: string get: operationId: getWpV2MenulocationsByLocation summary: GET /wp/v2/menu-locations/{location} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/menus: get: operationId: getWpV2Menus summary: GET /wp/v2/menus tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: asc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name description: Sort collection by term attribute. - name: hide_empty in: query required: false schema: type: boolean default: false description: Whether to hide terms not assigned to any posts. - name: post in: query required: false schema: type: integer description: Limit result set to terms assigned to a specific post. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to terms with one or more specific slugs. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2Menus summary: POST /wp/v2/menus tags: - wp/v2 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/menus/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2MenusById summary: GET /wp/v2/menus/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2MenusById summary: POST /wp/v2/menus/{id} tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2MenusById summary: PUT /wp/v2/menus/{id} tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2MenusById summary: PATCH /wp/v2/menus/{id} tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2MenusById summary: DELETE /wp/v2/menus/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as terms do not support trashing. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/navigation: get: operationId: getWpV2Navigation summary: GET /wp/v2/navigation tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: modified_after in: query required: false schema: type: string format: date-time description: Limit response to posts modified after a given ISO8601 compliant date. - name: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - name: modified_before in: query required: false schema: type: string format: date-time description: Limit response to posts modified before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date description: Sort collection by post attribute. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. - name: status in: query required: false schema: type: array default: publish items: type: string description: Limit result set to posts assigned one or more statuses. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2Navigation summary: POST /wp/v2/navigation tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/navigation/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2NavigationById summary: GET /wp/v2/navigation/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: password in: query required: false schema: type: string description: The password for the post if it is password protected. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2NavigationById summary: POST /wp/v2/navigation/{id} tags: - wp/v2 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: &id011 - 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2NavigationById summary: PUT /wp/v2/navigation/{id} tags: - wp/v2 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: *id011 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2NavigationById summary: PATCH /wp/v2/navigation/{id} tags: - wp/v2 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: *id011 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2NavigationById summary: DELETE /wp/v2/navigation/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/navigation/{id}/autosaves: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2NavigationByIdAutosaves summary: GET /wp/v2/navigation/{id}/autosaves tags: - wp/v2 parameters: - name: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2NavigationByIdAutosaves summary: POST /wp/v2/navigation/{id}/autosaves tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/navigation/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2NavigationByParentAutosavesById summary: GET /wp/v2/navigation/{parent}/autosaves/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/navigation/{parent}/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: getWpV2NavigationByParentRevisions summary: GET /wp/v2/navigation/{parent}/revisions tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date description: Sort collection by object attribute. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/navigation/{parent}/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2NavigationByParentRevisionsById summary: GET /wp/v2/navigation/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2NavigationByParentRevisionsById summary: DELETE /wp/v2/navigation/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as revisions do not support trashing. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/pages: get: operationId: getWpV2Pages summary: GET /wp/v2/pages tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: modified_after in: query required: false schema: type: string format: date-time description: Limit response to posts modified after a given ISO8601 compliant date. - name: author in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to posts assigned to specific authors. - name: author_exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes posts assigned to specific authors. - name: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - name: modified_before in: query required: false schema: type: string format: date-time description: Limit response to posts modified before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: menu_order in: query required: false schema: type: integer description: Limit result set to posts with a specific menu_order value. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title - menu_order default: date description: Sort collection by post attribute. - name: parent in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to items with particular parent IDs. - name: parent_exclude in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to all items except those of a particular parent ID. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. - name: status in: query required: false schema: type: array default: publish items: type: string description: Limit result set to posts assigned one or more statuses. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2Pages summary: POST /wp/v2/pages tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/pages/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2PagesById summary: GET /wp/v2/pages/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: excerpt_length in: query required: false schema: type: integer description: Override the default excerpt length. - name: password in: query required: false schema: type: string description: The password for the post if it is password protected. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2PagesById summary: POST /wp/v2/pages/{id} tags: - wp/v2 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: &id012 - 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: &id013 - open - closed description: Whether or not comments are open on the post. ping_status: type: string enum: &id014 - 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2PagesById summary: PUT /wp/v2/pages/{id} tags: - wp/v2 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: *id012 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: *id013 description: Whether or not comments are open on the post. ping_status: type: string enum: *id014 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2PagesById summary: PATCH /wp/v2/pages/{id} tags: - wp/v2 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: *id012 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: *id013 description: Whether or not comments are open on the post. ping_status: type: string enum: *id014 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2PagesById summary: DELETE /wp/v2/pages/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/pages/{id}/autosaves: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2PagesByIdAutosaves summary: GET /wp/v2/pages/{id}/autosaves tags: - wp/v2 parameters: - name: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2PagesByIdAutosaves summary: POST /wp/v2/pages/{id}/autosaves tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/pages/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2PagesByParentAutosavesById summary: GET /wp/v2/pages/{parent}/autosaves/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/pages/{parent}/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: getWpV2PagesByParentRevisions summary: GET /wp/v2/pages/{parent}/revisions tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date description: Sort collection by object attribute. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/pages/{parent}/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2PagesByParentRevisionsById summary: GET /wp/v2/pages/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2PagesByParentRevisionsById summary: DELETE /wp/v2/pages/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as revisions do not support trashing. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/pattern-directory/patterns: get: operationId: getWpV2PatterndirectoryPatterns summary: GET /wp/v2/pattern-directory/patterns tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 100 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: category in: query required: false schema: type: integer description: Limit results to those matching a category ID. - name: keyword in: query required: false schema: type: integer description: Limit results to those matching a keyword ID. - name: slug in: query required: false schema: type: array items: type: string description: Limit results to those matching a pattern (slug). - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title - favorite_count default: date description: Sort collection by post attribute. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/plugins: get: operationId: getWpV2Plugins summary: GET /wp/v2/plugins tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: status in: query required: false schema: type: array items: type: string description: Limits results to plugins with the given status. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2Plugins summary: POST /wp/v2/plugins tags: - wp/v2 requestBody: required: true content: application/json: schema: type: object properties: slug: type: string description: WordPress.org plugin directory slug. status: type: string enum: - inactive - active default: inactive description: The plugin activation status. required: - slug responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/plugins/{plugin}/]+(?:\/[^.\/]+)?): parameters: - name: plugin in: path required: true schema: type: string get: operationId: getWpV2PluginsByPlugin summary: GET /wp/v2/plugins/{plugin}/]+(?:\/[^.\/]+)?) tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2PluginsByPlugin summary: POST /wp/v2/plugins/{plugin}/]+(?:\/[^.\/]+)?) tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: context: type: string enum: &id015 - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. status: type: string enum: &id016 - inactive - active description: The plugin activation status. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2PluginsByPlugin summary: PUT /wp/v2/plugins/{plugin}/]+(?:\/[^.\/]+)?) tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: context: type: string enum: *id015 default: view description: Scope under which the request is made; determines fields present in response. status: type: string enum: *id016 description: The plugin activation status. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2PluginsByPlugin summary: PATCH /wp/v2/plugins/{plugin}/]+(?:\/[^.\/]+)?) tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: context: type: string enum: *id015 default: view description: Scope under which the request is made; determines fields present in response. status: type: string enum: *id016 description: The plugin activation status. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2PluginsByPlugin summary: DELETE /wp/v2/plugins/{plugin}/]+(?:\/[^.\/]+)?) tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/porto_builder: get: operationId: getWpV2PortoBuilder summary: GET /wp/v2/porto_builder tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: modified_after in: query required: false schema: type: string format: date-time description: Limit response to posts modified after a given ISO8601 compliant date. - name: author in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to posts assigned to specific authors. - name: author_exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes posts assigned to specific authors. - name: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - name: modified_before in: query required: false schema: type: string format: date-time description: Limit response to posts modified before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date description: Sort collection by post attribute. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. - name: status in: query required: false schema: type: array default: publish items: type: string description: Limit result set to posts assigned one or more statuses. - name: tax_relation in: query required: false schema: type: string enum: - AND - OR description: Limit result set based on relationship between multiple taxonomies. - name: porto_builder_type in: query required: false schema: type: object description: Limit result set to items with specific terms assigned in the porto_builder_type taxonomy. - name: porto_builder_type_exclude in: query required: false schema: type: object description: Limit result set to items except those with specific terms assigned in the porto_builder_type taxonomy. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2PortoBuilder summary: POST /wp/v2/porto_builder tags: - wp/v2 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. 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. porto_builder_type: type: array items: type: integer description: The terms assigned to the post in the porto_builder_type taxonomy. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/porto_builder/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2PortoBuilderById summary: GET /wp/v2/porto_builder/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: password in: query required: false schema: type: string description: The password for the post if it is password protected. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2PortoBuilderById summary: POST /wp/v2/porto_builder/{id} tags: - wp/v2 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: &id017 - 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. 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. porto_builder_type: type: array items: type: integer description: The terms assigned to the post in the porto_builder_type taxonomy. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2PortoBuilderById summary: PUT /wp/v2/porto_builder/{id} tags: - wp/v2 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: *id017 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. 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. porto_builder_type: type: array items: type: integer description: The terms assigned to the post in the porto_builder_type taxonomy. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2PortoBuilderById summary: PATCH /wp/v2/porto_builder/{id} tags: - wp/v2 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: *id017 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. 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. porto_builder_type: type: array items: type: integer description: The terms assigned to the post in the porto_builder_type taxonomy. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2PortoBuilderById summary: DELETE /wp/v2/porto_builder/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/porto_builder/{id}/autosaves: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2PortoBuilderByIdAutosaves summary: GET /wp/v2/porto_builder/{id}/autosaves tags: - wp/v2 parameters: - name: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2PortoBuilderByIdAutosaves summary: POST /wp/v2/porto_builder/{id}/autosaves tags: - wp/v2 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. 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. porto_builder_type: type: array items: type: integer description: The terms assigned to the post in the porto_builder_type taxonomy. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/porto_builder/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2PortoBuilderByParentAutosavesById summary: GET /wp/v2/porto_builder/{parent}/autosaves/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/porto_builder_type: get: operationId: getWpV2PortoBuilderType summary: GET /wp/v2/porto_builder_type tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: asc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name description: Sort collection by term attribute. - name: hide_empty in: query required: false schema: type: boolean default: false description: Whether to hide terms not assigned to any posts. - name: post in: query required: false schema: type: integer description: Limit result set to terms assigned to a specific post. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to terms with one or more specific slugs. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2PortoBuilderType summary: POST /wp/v2/porto_builder_type tags: - wp/v2 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/porto_builder_type/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2PortoBuilderTypeById summary: GET /wp/v2/porto_builder_type/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2PortoBuilderTypeById summary: POST /wp/v2/porto_builder_type/{id} tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2PortoBuilderTypeById summary: PUT /wp/v2/porto_builder_type/{id} tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2PortoBuilderTypeById summary: PATCH /wp/v2/porto_builder_type/{id} tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2PortoBuilderTypeById summary: DELETE /wp/v2/porto_builder_type/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as terms do not support trashing. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/posts: get: operationId: getWpV2Posts summary: GET /wp/v2/posts tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: modified_after in: query required: false schema: type: string format: date-time description: Limit response to posts modified after a given ISO8601 compliant date. - name: author in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to posts assigned to specific authors. - name: author_exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes posts assigned to specific authors. - name: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - name: modified_before in: query required: false schema: type: string format: date-time description: Limit response to posts modified before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date description: Sort collection by post attribute. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. - name: status in: query required: false schema: type: array default: publish items: type: string description: Limit result set to posts assigned one or more statuses. - name: tax_relation in: query required: false schema: type: string enum: - AND - OR description: Limit result set based on relationship between multiple taxonomies. - name: categories in: query required: false schema: type: object description: Limit result set to items with specific terms assigned in the categories taxonomy. - name: categories_exclude in: query required: false schema: type: object description: Limit result set to items except those with specific terms assigned in the categories taxonomy. - name: tags in: query required: false schema: type: object description: Limit result set to items with specific terms assigned in the tags taxonomy. - name: tags_exclude in: query required: false schema: type: object description: Limit result set to items except those with specific terms assigned in the tags taxonomy. - name: sticky in: query required: false schema: type: boolean description: Limit result set to items that are sticky. - name: ignore_sticky in: query required: false schema: type: boolean default: true description: Whether to ignore sticky posts or not. - name: format in: query required: false schema: type: array items: type: string description: Limit result set to items assigned one or more given formats. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2Posts summary: POST /wp/v2/posts tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/posts/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2PostsById summary: GET /wp/v2/posts/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: excerpt_length in: query required: false schema: type: integer description: Override the default excerpt length. - name: password in: query required: false schema: type: string description: The password for the post if it is password protected. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2PostsById summary: POST /wp/v2/posts/{id} tags: - wp/v2 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: &id018 - 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: &id019 - open - closed description: Whether or not comments are open on the post. ping_status: type: string enum: &id020 - open - closed description: Whether or not the post can be pinged. format: type: string enum: &id021 - 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2PostsById summary: PUT /wp/v2/posts/{id} tags: - wp/v2 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: *id018 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: *id019 description: Whether or not comments are open on the post. ping_status: type: string enum: *id020 description: Whether or not the post can be pinged. format: type: string enum: *id021 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2PostsById summary: PATCH /wp/v2/posts/{id} tags: - wp/v2 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: *id018 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: *id019 description: Whether or not comments are open on the post. ping_status: type: string enum: *id020 description: Whether or not the post can be pinged. format: type: string enum: *id021 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2PostsById summary: DELETE /wp/v2/posts/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/posts/{id}/autosaves: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2PostsByIdAutosaves summary: GET /wp/v2/posts/{id}/autosaves tags: - wp/v2 parameters: - name: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2PostsByIdAutosaves summary: POST /wp/v2/posts/{id}/autosaves tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/posts/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2PostsByParentAutosavesById summary: GET /wp/v2/posts/{parent}/autosaves/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/posts/{parent}/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: getWpV2PostsByParentRevisions summary: GET /wp/v2/posts/{parent}/revisions tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date description: Sort collection by object attribute. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/posts/{parent}/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2PostsByParentRevisionsById summary: GET /wp/v2/posts/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2PostsByParentRevisionsById summary: DELETE /wp/v2/posts/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as revisions do not support trashing. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/search: get: operationId: getWpV2Search summary: GET /wp/v2/search tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: type in: query required: false schema: type: string enum: - post - term - post-format default: post description: Limit results to items of an object type. - name: subtype in: query required: false schema: type: array default: any items: type: string description: Limit results to items of one or more object subtypes. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/settings: get: operationId: getWpV2Settings summary: GET /wp/v2/settings tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2Settings summary: POST /wp/v2/settings tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: 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: &id022 - open - closed description: Allow link notifications from other blogs (pingbacks and trackbacks) on new articles. default_comment_status: type: string enum: &id023 - 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2Settings summary: PUT /wp/v2/settings tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: 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: *id022 description: Allow link notifications from other blogs (pingbacks and trackbacks) on new articles. default_comment_status: type: string enum: *id023 description: Allow people to submit comments on new posts. site_logo: type: integer description: Site logo. site_icon: type: integer description: Site icon. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2Settings summary: PATCH /wp/v2/settings tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: 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: *id022 description: Allow link notifications from other blogs (pingbacks and trackbacks) on new articles. default_comment_status: type: string enum: *id023 description: Allow people to submit comments on new posts. site_logo: type: integer description: Site logo. site_icon: type: integer description: Site icon. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/sidebars: get: operationId: getWpV2Sidebars summary: GET /wp/v2/sidebars tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/sidebars/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2SidebarsById summary: GET /wp/v2/sidebars/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2SidebarsById summary: POST /wp/v2/sidebars/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: widgets: type: array items: type: object description: Nested widgets. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2SidebarsById summary: PUT /wp/v2/sidebars/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: widgets: type: array items: type: object description: Nested widgets. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2SidebarsById summary: PATCH /wp/v2/sidebars/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: widgets: type: array items: type: object description: Nested widgets. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/statuses: get: operationId: getWpV2Statuses summary: GET /wp/v2/statuses tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/statuses/{status}: parameters: - name: status in: path required: true schema: type: string get: operationId: getWpV2StatusesByStatus summary: GET /wp/v2/statuses/{status} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/tags: get: operationId: getWpV2Tags summary: GET /wp/v2/tags tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: asc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name description: Sort collection by term attribute. - name: hide_empty in: query required: false schema: type: boolean default: false description: Whether to hide terms not assigned to any posts. - name: post in: query required: false schema: type: integer description: Limit result set to terms assigned to a specific post. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to terms with one or more specific slugs. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2Tags summary: POST /wp/v2/tags tags: - wp/v2 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/tags/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2TagsById summary: GET /wp/v2/tags/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2TagsById summary: POST /wp/v2/tags/{id} tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2TagsById summary: PUT /wp/v2/tags/{id} tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2TagsById summary: PATCH /wp/v2/tags/{id} tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2TagsById summary: DELETE /wp/v2/tags/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as terms do not support trashing. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/taxonomies: get: operationId: getWpV2Taxonomies summary: GET /wp/v2/taxonomies tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: type in: query required: false schema: type: string description: Limit results to taxonomies associated with a specific post type. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/taxonomies/{taxonomy}: parameters: - name: taxonomy in: path required: true schema: type: string get: operationId: getWpV2TaxonomiesByTaxonomy summary: GET /wp/v2/taxonomies/{taxonomy} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/template-parts: get: operationId: getWpV2Templateparts summary: GET /wp/v2/template-parts tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: wp_id in: query required: false schema: type: integer description: Limit to the specified post id. - name: area in: query required: false schema: type: string description: Limit to the specified template part area. - name: post_type in: query required: false schema: type: string description: Post type to get the templates for. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2Templateparts summary: POST /wp/v2/template-parts tags: - wp/v2 requestBody: required: true content: application/json: schema: type: object properties: slug: type: string 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 default: '' description: Content of template. title: type: object 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/template-parts/{id}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+): parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2TemplatepartsByIdw summary: GET /wp/v2/template-parts/{id}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+) tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2TemplatepartsByIdw summary: POST /wp/v2/template-parts/{id}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+) tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: slug: type: string 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 description: Content of template. title: type: object description: Title of template. description: type: string description: Description of template. status: type: string enum: &id024 - 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.) responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2TemplatepartsByIdw summary: PUT /wp/v2/template-parts/{id}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+) tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: slug: type: string 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 description: Content of template. title: type: object description: Title of template. description: type: string description: Description of template. status: type: string enum: *id024 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.) responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2TemplatepartsByIdw summary: PATCH /wp/v2/template-parts/{id}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+) tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: slug: type: string 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 description: Content of template. title: type: object description: Title of template. description: type: string description: Description of template. status: type: string enum: *id024 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.) responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2TemplatepartsByIdw summary: DELETE /wp/v2/template-parts/{id}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+) tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/template-parts/{id}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/autosaves: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2TemplatepartsByIdwAutosaves summary: GET /wp/v2/template-parts/{id}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/autosaves tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2TemplatepartsByIdwAutosaves summary: POST /wp/v2/template-parts/{id}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/autosaves tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: slug: type: string 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 description: Content of template. title: type: object 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.) responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/template-parts/{parent}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2TemplatepartsByParentwAutosavesById summary: GET /wp/v2/template-parts/{parent}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/autosaves/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/template-parts/{parent}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: getWpV2TemplatepartsByParentwRevisions summary: GET /wp/v2/template-parts/{parent}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/revisions tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date description: Sort collection by object attribute. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/template-parts/{parent}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2TemplatepartsByParentwRevisionsById summary: GET /wp/v2/template-parts/{parent}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/revisions/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2TemplatepartsByParentwRevisionsById summary: DELETE /wp/v2/template-parts/{parent}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/revisions/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as revisions do not support trashing. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/template-parts/lookup: get: operationId: getWpV2TemplatepartsLookup summary: GET /wp/v2/template-parts/lookup tags: - wp/v2 parameters: - name: slug in: query required: true schema: type: string description: The slug of the template to get the fallback for - name: is_custom in: query required: false schema: type: boolean description: Indicates if a template is custom or part of the template hierarchy - name: template_prefix in: query required: false schema: type: string description: The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy` responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/templates: get: operationId: getWpV2Templates summary: GET /wp/v2/templates tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: wp_id in: query required: false schema: type: integer description: Limit to the specified post id. - name: area in: query required: false schema: type: string description: Limit to the specified template part area. - name: post_type in: query required: false schema: type: string description: Post type to get the templates for. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2Templates summary: POST /wp/v2/templates tags: - wp/v2 requestBody: required: true content: application/json: schema: type: object properties: slug: type: string 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 default: '' description: Content of template. title: type: object 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/templates/{id}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+): parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2TemplatesByIdw summary: GET /wp/v2/templates/{id}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+) tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2TemplatesByIdw summary: POST /wp/v2/templates/{id}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+) tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: slug: type: string 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 description: Content of template. title: type: object description: Title of template. description: type: string description: Description of template. status: type: string enum: &id025 - publish - future - draft - pending - private - acf-disabled description: Status of template. author: type: integer description: The ID for the author of the template. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2TemplatesByIdw summary: PUT /wp/v2/templates/{id}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+) tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: slug: type: string 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 description: Content of template. title: type: object description: Title of template. description: type: string description: Description of template. status: type: string enum: *id025 description: Status of template. author: type: integer description: The ID for the author of the template. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2TemplatesByIdw summary: PATCH /wp/v2/templates/{id}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+) tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: slug: type: string 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 description: Content of template. title: type: object description: Title of template. description: type: string description: Description of template. status: type: string enum: *id025 description: Status of template. author: type: integer description: The ID for the author of the template. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2TemplatesByIdw summary: DELETE /wp/v2/templates/{id}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+) tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/templates/{id}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/autosaves: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2TemplatesByIdwAutosaves summary: GET /wp/v2/templates/{id}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/autosaves tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2TemplatesByIdwAutosaves summary: POST /wp/v2/templates/{id}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/autosaves tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: slug: type: string 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 description: Content of template. title: type: object 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/templates/{parent}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2TemplatesByParentwAutosavesById summary: GET /wp/v2/templates/{parent}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/autosaves/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/templates/{parent}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: getWpV2TemplatesByParentwRevisions summary: GET /wp/v2/templates/{parent}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/revisions tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date description: Sort collection by object attribute. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/templates/{parent}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2TemplatesByParentwRevisionsById summary: GET /wp/v2/templates/{parent}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/revisions/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2TemplatesByParentwRevisionsById summary: DELETE /wp/v2/templates/{parent}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)[\/\w%-]+)/revisions/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as revisions do not support trashing. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/templates/lookup: get: operationId: getWpV2TemplatesLookup summary: GET /wp/v2/templates/lookup tags: - wp/v2 parameters: - name: slug in: query required: true schema: type: string description: The slug of the template to get the fallback for - name: is_custom in: query required: false schema: type: boolean description: Indicates if a template is custom or part of the template hierarchy - name: template_prefix in: query required: false schema: type: string description: The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy` responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/themes: get: operationId: getWpV2Themes summary: GET /wp/v2/themes tags: - wp/v2 parameters: - name: status in: query required: false schema: type: array items: type: string description: Limit result set to themes assigned one or more statuses. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/themes/{stylesheet}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?): parameters: - name: stylesheet in: path required: true schema: type: string get: operationId: getWpV2ThemesByStylesheet summary: GET /wp/v2/themes/{stylesheet}/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?) tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/types: get: operationId: getWpV2Types summary: GET /wp/v2/types tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/types/{type}: parameters: - name: type in: path required: true schema: type: string get: operationId: getWpV2TypesByType summary: GET /wp/v2/types/{type} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/users: get: operationId: getWpV2Users summary: GET /wp/v2/users tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: asc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - id - include - name - registered_date - slug - include_slugs - email - url default: name description: Sort collection by user attribute. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to users with one or more specific slugs. - name: roles in: query required: false schema: type: array items: type: string description: Limit result set to users matching at least one specific role provided. Accepts csv list or single role. - name: capabilities in: query required: false schema: type: array items: type: string description: Limit result set to users matching at least one specific capability provided. Accepts csv list or single capability. - name: who in: query required: false schema: type: string enum: - authors description: Limit result set to users who are considered authors. - name: has_published_posts in: query required: false schema: type: boolean description: Limit result set to users who have published posts. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2Users summary: POST /wp/v2/users tags: - wp/v2 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. required: - username - email - password responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/users/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2UsersById summary: GET /wp/v2/users/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2UsersById summary: POST /wp/v2/users/{id} tags: - wp/v2 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: &id026 - '' - 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2UsersById summary: PUT /wp/v2/users/{id} tags: - wp/v2 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: *id026 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2UsersById summary: PATCH /wp/v2/users/{id} tags: - wp/v2 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: *id026 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2UsersById summary: DELETE /wp/v2/users/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as users do not support trashing. - name: reassign in: query required: true schema: type: integer description: Reassign the deleted user's posts and links to this user ID. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/users/{user_id}/application-passwords: parameters: - name: user_id in: path required: true schema: type: string get: operationId: getWpV2UsersByUserIdApplicationpasswords summary: GET /wp/v2/users/{user_id}/application-passwords tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2UsersByUserIdApplicationpasswords summary: POST /wp/v2/users/{user_id}/application-passwords tags: - wp/v2 requestBody: required: true content: application/json: schema: type: object properties: app_id: type: string description: A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace. name: type: string description: The name of the application password. required: - name responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2UsersByUserIdApplicationpasswords summary: DELETE /wp/v2/users/{user_id}/application-passwords tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/users/{user_id}/application-passwords/{uuid}: parameters: - name: user_id in: path required: true schema: type: string - name: uuid in: path required: true schema: type: string get: operationId: getWpV2UsersByUserIdApplicationpasswordsByUuid summary: GET /wp/v2/users/{user_id}/application-passwords/{uuid} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2UsersByUserIdApplicationpasswordsByUuid summary: POST /wp/v2/users/{user_id}/application-passwords/{uuid} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: app_id: type: string description: A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace. name: type: string description: The name of the application password. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2UsersByUserIdApplicationpasswordsByUuid summary: PUT /wp/v2/users/{user_id}/application-passwords/{uuid} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: app_id: type: string description: A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace. name: type: string description: The name of the application password. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2UsersByUserIdApplicationpasswordsByUuid summary: PATCH /wp/v2/users/{user_id}/application-passwords/{uuid} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: app_id: type: string description: A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace. name: type: string description: The name of the application password. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2UsersByUserIdApplicationpasswordsByUuid summary: DELETE /wp/v2/users/{user_id}/application-passwords/{uuid} tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/users/{user_id}/application-passwords/introspect: parameters: - name: user_id in: path required: true schema: type: string get: operationId: getWpV2UsersByUserIdApplicationpasswordsIntrospect summary: GET /wp/v2/users/{user_id}/application-passwords/introspect tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/users/me: get: operationId: getWpV2UsersMe summary: GET /wp/v2/users/me tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2UsersMe summary: POST /wp/v2/users/me tags: - wp/v2 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: &id027 - '' - 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2UsersMe summary: PUT /wp/v2/users/me tags: - wp/v2 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: *id027 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2UsersMe summary: PATCH /wp/v2/users/me tags: - wp/v2 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: *id027 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2UsersMe summary: DELETE /wp/v2/users/me tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as users do not support trashing. - name: reassign in: query required: true schema: type: integer description: Reassign the deleted user's posts and links to this user ID. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/widget-types: get: operationId: getWpV2Widgettypes summary: GET /wp/v2/widget-types tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/widget-types/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2WidgettypesById summary: GET /wp/v2/widget-types/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/widget-types/{id}/encode: parameters: - name: id in: path required: true schema: type: string post: operationId: postWpV2WidgettypesByIdEncode summary: POST /wp/v2/widget-types/{id}/encode tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/widget-types/{id}/render: parameters: - name: id in: path required: true schema: type: string post: operationId: postWpV2WidgettypesByIdRender summary: POST /wp/v2/widget-types/{id}/render tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: instance: type: object description: Current instance settings of the widget. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/widgets: get: operationId: getWpV2Widgets summary: GET /wp/v2/widgets tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: sidebar in: query required: false schema: type: string description: The sidebar to return widgets for. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2Widgets summary: POST /wp/v2/widgets tags: - wp/v2 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/widgets/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2WidgetsById summary: GET /wp/v2/widgets/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2WidgetsById summary: POST /wp/v2/widgets/{id} tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2WidgetsById summary: PUT /wp/v2/widgets/{id} tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2WidgetsById summary: PATCH /wp/v2/widgets/{id} tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2WidgetsById summary: DELETE /wp/v2/widgets/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean description: Whether to force removal of the widget, or move it to the inactive sidebar. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/wp_pattern_category: get: operationId: getWpV2WpPatternCategory summary: GET /wp/v2/wp_pattern_category tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: asc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name description: Sort collection by term attribute. - name: hide_empty in: query required: false schema: type: boolean default: false description: Whether to hide terms not assigned to any posts. - name: post in: query required: false schema: type: integer description: Limit result set to terms assigned to a specific post. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to terms with one or more specific slugs. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2WpPatternCategory summary: POST /wp/v2/wp_pattern_category tags: - wp/v2 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/wp_pattern_category/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2WpPatternCategoryById summary: GET /wp/v2/wp_pattern_category/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2WpPatternCategoryById summary: POST /wp/v2/wp_pattern_category/{id} tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2WpPatternCategoryById summary: PUT /wp/v2/wp_pattern_category/{id} tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2WpPatternCategoryById summary: PATCH /wp/v2/wp_pattern_category/{id} tags: - wp/v2 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2WpPatternCategoryById summary: DELETE /wp/v2/wp_pattern_category/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as terms do not support trashing. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/wpb_gutenberg_param: get: operationId: getWpV2WpbGutenbergParam summary: GET /wp/v2/wpb_gutenberg_param tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: modified_after in: query required: false schema: type: string format: date-time description: Limit response to posts modified after a given ISO8601 compliant date. - name: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - name: modified_before in: query required: false schema: type: string format: date-time description: Limit response to posts modified before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date description: Sort collection by post attribute. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. - name: status in: query required: false schema: type: array default: publish items: type: string description: Limit result set to posts assigned one or more statuses. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2WpbGutenbergParam summary: POST /wp/v2/wpb_gutenberg_param tags: - wp/v2 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. content: type: object description: The content for the post. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/wpb_gutenberg_param/{id}: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2WpbGutenbergParamById summary: GET /wp/v2/wpb_gutenberg_param/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: password in: query required: false schema: type: string description: The password for the post if it is password protected. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2WpbGutenbergParamById summary: POST /wp/v2/wpb_gutenberg_param/{id} tags: - wp/v2 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: &id028 - 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. content: type: object description: The content for the post. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' put: operationId: putWpV2WpbGutenbergParamById summary: PUT /wp/v2/wpb_gutenberg_param/{id} tags: - wp/v2 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: *id028 description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. content: type: object description: The content for the post. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' patch: operationId: patchWpV2WpbGutenbergParamById summary: PATCH /wp/v2/wpb_gutenberg_param/{id} tags: - wp/v2 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: *id028 description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. content: type: object description: The content for the post. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' delete: operationId: deleteWpV2WpbGutenbergParamById summary: DELETE /wp/v2/wpb_gutenberg_param/{id} tags: - wp/v2 parameters: - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/wpb_gutenberg_param/{id}/autosaves: parameters: - name: id in: path required: true schema: type: string get: operationId: getWpV2WpbGutenbergParamByIdAutosaves summary: GET /wp/v2/wpb_gutenberg_param/{id}/autosaves tags: - wp/v2 parameters: - name: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' post: operationId: postWpV2WpbGutenbergParamByIdAutosaves summary: POST /wp/v2/wpb_gutenberg_param/{id}/autosaves tags: - wp/v2 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. content: type: object description: The content for the post. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' /wp/v2/wpb_gutenberg_param/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: operationId: getWpV2WpbGutenbergParamByParentAutosavesById summary: GET /wp/v2/wpb_gutenberg_param/{parent}/autosaves/{id} tags: - wp/v2 parameters: - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/WPError' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPError' '403': description: Forbidden — the current user cannot perform this action content: application/json: schema: $ref: '#/components/schemas/WPError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPError' components: schemas: WPError: type: object description: WordPress REST API error envelope, observed live on this host. properties: code: type: string description: Machine-readable error code, e.g. mcp_unauthorized. message: type: string description: Human-readable error message. data: type: object properties: status: type: integer description: HTTP status code. securitySchemes: wpNonce: type: apiKey in: header name: X-WP-Nonce description: WordPress cookie-authenticated nonce, accepted per the Access-Control-Allow-Headers advertised by this host. bearerAuth: type: http scheme: bearer description: 'Bearer token accepted per the advertised Access-Control-Allow-Headers: Authorization.'