{ "openapi": "3.1.0", "info": { "title": "VaynerMedia WordPress Content API", "version": "wp/v2", "summary": "Public read surface of the WordPress REST API served at vaynermedia.com/wp-json/.", "description": "VaynerMedia runs vaynermedia.com on self-hosted WordPress (WP Engine) and leaves the WordPress REST API open for anonymous reads. This document describes the portion of that API that is actually callable without credentials: the wp/v2 content collections, the site's two custom post types (case_study, salient_g_sections), the Popup Maker types, and the registry endpoints.\n\nIt was DERIVED from the provider's own machine-readable route index at https://vaynermedia.com/wp-json/ (365 registered routes) on 2026-08-12 \u2014 every path, parameter, type, default and enum below is copied from that document. VaynerMedia does not publish an OpenAPI itself, and this is not a product API: it is the content surface of the agency's marketing site. Write methods (POST/PUT/PATCH/DELETE) are registered but reject anonymous callers, and are deliberately excluded. Routes that returned 401/403 anonymously (templates, template-parts, menu-items, settings, navigation revisions, users) are excluded for the same reason.", "contact": { "name": "VaynerMedia", "url": "https://vaynermedia.com/connect/" }, "x-derived-from": "https://vaynermedia.com/wp-json/", "x-derived-on": "2026-08-12", "x-upstream-documentation": "https://developer.wordpress.org/rest-api/" }, "servers": [ { "url": "https://vaynermedia.com/wp-json", "description": "Production WordPress REST API for vaynermedia.com" } ], "tags": [ { "name": "Posts", "description": "Blog posts and articles published on vaynermedia.com." }, { "name": "Pages", "description": "Static pages on vaynermedia.com." }, { "name": "Media", "description": "Media library attachments (images, video, documents)." }, { "name": "Categories", "description": "Post categories taxonomy." }, { "name": "Tags", "description": "Post tags taxonomy." }, { "name": "Comments", "description": "Approved comments." }, { "name": "Search", "description": "Cross-content-type search index." }, { "name": "Types", "description": "Registered post types." }, { "name": "Statuses", "description": "Registered post statuses." }, { "name": "Taxonomies", "description": "Registered taxonomies." }, { "name": "CaseStudies", "description": "VaynerMedia client case studies (custom post type)." }, { "name": "Popups", "description": "Popup Maker themes." }, { "name": "Blocks", "description": "Salient theme global sections (custom post type)." } ], "paths": { "/wp/v2/posts": { "get": { "operationId": "list_posts", "summary": "List posts", "description": "Blog posts and articles published on vaynermedia.com. Read-only for anonymous callers; the collection also accepts POST for authenticated editors, which is not documented here.", "tags": [ "Posts" ], "parameters": [ { "name": "after", "in": "query", "description": "Limit response to posts published after a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "author", "in": "query", "description": "Limit result set to posts assigned to specific authors.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "author_exclude", "in": "query", "description": "Ensure result set excludes posts assigned to specific authors.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "before", "in": "query", "description": "Limit response to posts published before a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "categories", "in": "query", "description": "Limit result set to items with specific terms assigned in the categories taxonomy.", "schema": { "type": [ "object", "array" ] } }, { "name": "categories_exclude", "in": "query", "description": "Limit result set to items except those with specific terms assigned in the categories taxonomy.", "schema": { "type": [ "object", "array" ] } }, { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } }, { "name": "exclude", "in": "query", "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "format", "in": "query", "description": "Limit result set to items assigned one or more given formats.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio" ] } } }, { "name": "ignore_sticky", "in": "query", "description": "Whether to ignore sticky posts or not.", "schema": { "type": "boolean", "default": true } }, { "name": "include", "in": "query", "description": "Limit result set to specific IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "modified_after", "in": "query", "description": "Limit response to posts modified after a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Limit response to posts modified before a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Offset the result set by a specific number of items.", "schema": { "type": "integer" } }, { "name": "order", "in": "query", "description": "Order sort attribute ascending or descending.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "orderby", "in": "query", "description": "Sort collection by post attribute.", "schema": { "type": "string", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title" ], "default": "date" } }, { "name": "page", "in": "query", "description": "Current page of the collection.", "schema": { "type": "integer", "default": 1, "minimum": 1 } }, { "name": "per_page", "in": "query", "description": "Maximum number of items to be returned in result set.", "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 } }, { "name": "search", "in": "query", "description": "Limit results to those matching a string.", "schema": { "type": "string" } }, { "name": "search_columns", "in": "query", "description": "Array of column names to be searched.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "string", "enum": [ "post_title", "post_content", "post_excerpt" ] } } }, { "name": "search_semantics", "in": "query", "description": "How to interpret the search input.", "schema": { "type": "string", "enum": [ "exact" ] } }, { "name": "slug", "in": "query", "description": "Limit result set to posts with one or more specific slugs.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "status", "in": "query", "description": "Limit result set to posts assigned one or more statuses.", "style": "form", "explode": false, "schema": { "type": "array", "default": "publish", "items": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "email_sent", "email_failed", "email_scheduled", "any" ] } } }, { "name": "sticky", "in": "query", "description": "Limit result set to items that are sticky.", "schema": { "type": "boolean" } }, { "name": "tags", "in": "query", "description": "Limit result set to items with specific terms assigned in the tags taxonomy.", "schema": { "type": [ "object", "array" ] } }, { "name": "tags_exclude", "in": "query", "description": "Limit result set to items except those with specific terms assigned in the tags taxonomy.", "schema": { "type": [ "object", "array" ] } }, { "name": "tax_relation", "in": "query", "description": "Limit result set based on relationship between multiple taxonomies.", "schema": { "type": "string", "enum": [ "AND", "OR" ] } } ], "responses": { "200": { "description": "A list of posts.", "headers": { "X-WP-Total": { "description": "Total number of matching records.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next / rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/posts/{id}": { "get": { "operationId": "get_posts", "summary": "Retrieve a post", "description": "Retrieve a single post by id.", "tags": [ "Posts" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier for the post.", "schema": { "type": "integer" }, "required": true }, { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } }, { "name": "excerpt_length", "in": "query", "description": "Override the default excerpt length.", "schema": { "type": "integer" } }, { "name": "password", "in": "query", "description": "The password for the post if it is password protected.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested record.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/pages": { "get": { "operationId": "list_pages", "summary": "List pages", "description": "Static pages on vaynermedia.com. Read-only for anonymous callers; the collection also accepts POST for authenticated editors, which is not documented here.", "tags": [ "Pages" ], "parameters": [ { "name": "after", "in": "query", "description": "Limit response to posts published after a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "author", "in": "query", "description": "Limit result set to posts assigned to specific authors.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "author_exclude", "in": "query", "description": "Ensure result set excludes posts assigned to specific authors.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "before", "in": "query", "description": "Limit response to posts published before a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } }, { "name": "exclude", "in": "query", "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "include", "in": "query", "description": "Limit result set to specific IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "menu_order", "in": "query", "description": "Limit result set to posts with a specific menu_order value.", "schema": { "type": "integer" } }, { "name": "modified_after", "in": "query", "description": "Limit response to posts modified after a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Limit response to posts modified before a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Offset the result set by a specific number of items.", "schema": { "type": "integer" } }, { "name": "order", "in": "query", "description": "Order sort attribute ascending or descending.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "orderby", "in": "query", "description": "Sort collection by post attribute.", "schema": { "type": "string", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order" ], "default": "date" } }, { "name": "page", "in": "query", "description": "Current page of the collection.", "schema": { "type": "integer", "default": 1, "minimum": 1 } }, { "name": "parent", "in": "query", "description": "Limit result set to items with particular parent IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "parent_exclude", "in": "query", "description": "Limit result set to all items except those of a particular parent ID.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "per_page", "in": "query", "description": "Maximum number of items to be returned in result set.", "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 } }, { "name": "search", "in": "query", "description": "Limit results to those matching a string.", "schema": { "type": "string" } }, { "name": "search_columns", "in": "query", "description": "Array of column names to be searched.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "string", "enum": [ "post_title", "post_content", "post_excerpt" ] } } }, { "name": "search_semantics", "in": "query", "description": "How to interpret the search input.", "schema": { "type": "string", "enum": [ "exact" ] } }, { "name": "slug", "in": "query", "description": "Limit result set to posts with one or more specific slugs.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "status", "in": "query", "description": "Limit result set to posts assigned one or more statuses.", "style": "form", "explode": false, "schema": { "type": "array", "default": "publish", "items": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "email_sent", "email_failed", "email_scheduled", "any" ] } } } ], "responses": { "200": { "description": "A list of pages.", "headers": { "X-WP-Total": { "description": "Total number of matching records.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next / rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/pages/{id}": { "get": { "operationId": "get_pages", "summary": "Retrieve a page", "description": "Retrieve a single page by id.", "tags": [ "Pages" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier for the post.", "schema": { "type": "integer" }, "required": true }, { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } }, { "name": "excerpt_length", "in": "query", "description": "Override the default excerpt length.", "schema": { "type": "integer" } }, { "name": "password", "in": "query", "description": "The password for the post if it is password protected.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested record.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/media": { "get": { "operationId": "list_media", "summary": "List media", "description": "Media library attachments (images, video, documents). Read-only for anonymous callers; the collection also accepts POST for authenticated editors, which is not documented here.", "tags": [ "Media" ], "parameters": [ { "name": "after", "in": "query", "description": "Limit response to posts published after a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "author", "in": "query", "description": "Limit result set to posts assigned to specific authors.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "author_exclude", "in": "query", "description": "Ensure result set excludes posts assigned to specific authors.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "before", "in": "query", "description": "Limit response to posts published before a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } }, { "name": "exclude", "in": "query", "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "include", "in": "query", "description": "Limit result set to specific IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "media_type", "in": "query", "description": "Limit result set to attachments of a particular media type or media types.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "image", "video", "text", "application", "audio" ] } } }, { "name": "mime_type", "in": "query", "description": "Limit result set to attachments of a particular MIME type or MIME types.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "modified_after", "in": "query", "description": "Limit response to posts modified after a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Limit response to posts modified before a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Offset the result set by a specific number of items.", "schema": { "type": "integer" } }, { "name": "order", "in": "query", "description": "Order sort attribute ascending or descending.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "orderby", "in": "query", "description": "Sort collection by post attribute.", "schema": { "type": "string", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title" ], "default": "date" } }, { "name": "page", "in": "query", "description": "Current page of the collection.", "schema": { "type": "integer", "default": 1, "minimum": 1 } }, { "name": "parent", "in": "query", "description": "Limit result set to items with particular parent IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "parent_exclude", "in": "query", "description": "Limit result set to all items except those of a particular parent ID.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "per_page", "in": "query", "description": "Maximum number of items to be returned in result set.", "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 } }, { "name": "search", "in": "query", "description": "Limit results to those matching a string.", "schema": { "type": "string" } }, { "name": "search_columns", "in": "query", "description": "Array of column names to be searched.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "string", "enum": [ "post_title", "post_content", "post_excerpt" ] } } }, { "name": "search_semantics", "in": "query", "description": "How to interpret the search input.", "schema": { "type": "string", "enum": [ "exact" ] } }, { "name": "slug", "in": "query", "description": "Limit result set to posts with one or more specific slugs.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "status", "in": "query", "description": "Limit result set to posts assigned one or more statuses.", "style": "form", "explode": false, "schema": { "type": "array", "default": "inherit", "items": { "type": "string", "enum": [ "inherit", "private", "trash" ] } } } ], "responses": { "200": { "description": "A list of media.", "headers": { "X-WP-Total": { "description": "Total number of matching records.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next / rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/media/{id}": { "get": { "operationId": "get_media", "summary": "Retrieve a media item", "description": "Retrieve a single media item by id.", "tags": [ "Media" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier for the post.", "schema": { "type": "integer" }, "required": true }, { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } } ], "responses": { "200": { "description": "The requested record.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/categories": { "get": { "operationId": "list_categories", "summary": "List categories", "description": "Post categories taxonomy. Read-only for anonymous callers; the collection also accepts POST for authenticated editors, which is not documented here.", "tags": [ "Categories" ], "parameters": [ { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } }, { "name": "exclude", "in": "query", "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "hide_empty", "in": "query", "description": "Whether to hide terms not assigned to any posts.", "schema": { "type": "boolean", "default": false } }, { "name": "include", "in": "query", "description": "Limit result set to specific IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "order", "in": "query", "description": "Order sort attribute ascending or descending.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "orderby", "in": "query", "description": "Sort collection by term attribute.", "schema": { "type": "string", "enum": [ "id", "include", "name", "slug", "include_slugs", "term_group", "description", "count" ], "default": "name" } }, { "name": "page", "in": "query", "description": "Current page of the collection.", "schema": { "type": "integer", "default": 1, "minimum": 1 } }, { "name": "parent", "in": "query", "description": "Limit result set to terms assigned to a specific parent.", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Maximum number of items to be returned in result set.", "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 } }, { "name": "post", "in": "query", "description": "Limit result set to terms assigned to a specific post.", "schema": { "type": "integer" } }, { "name": "search", "in": "query", "description": "Limit results to those matching a string.", "schema": { "type": "string" } }, { "name": "slug", "in": "query", "description": "Limit result set to terms with one or more specific slugs.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "A list of categories.", "headers": { "X-WP-Total": { "description": "Total number of matching records.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next / rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/categories/{id}": { "get": { "operationId": "get_categories", "summary": "Retrieve a category", "description": "Retrieve a single category by id.", "tags": [ "Categories" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier for the term.", "schema": { "type": "integer" }, "required": true }, { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } } ], "responses": { "200": { "description": "The requested record.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/tags": { "get": { "operationId": "list_tags", "summary": "List tags", "description": "Post tags taxonomy. Read-only for anonymous callers; the collection also accepts POST for authenticated editors, which is not documented here.", "tags": [ "Tags" ], "parameters": [ { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } }, { "name": "exclude", "in": "query", "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "hide_empty", "in": "query", "description": "Whether to hide terms not assigned to any posts.", "schema": { "type": "boolean", "default": false } }, { "name": "include", "in": "query", "description": "Limit result set to specific IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "offset", "in": "query", "description": "Offset the result set by a specific number of items.", "schema": { "type": "integer" } }, { "name": "order", "in": "query", "description": "Order sort attribute ascending or descending.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "orderby", "in": "query", "description": "Sort collection by term attribute.", "schema": { "type": "string", "enum": [ "id", "include", "name", "slug", "include_slugs", "term_group", "description", "count" ], "default": "name" } }, { "name": "page", "in": "query", "description": "Current page of the collection.", "schema": { "type": "integer", "default": 1, "minimum": 1 } }, { "name": "per_page", "in": "query", "description": "Maximum number of items to be returned in result set.", "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 } }, { "name": "post", "in": "query", "description": "Limit result set to terms assigned to a specific post.", "schema": { "type": "integer" } }, { "name": "search", "in": "query", "description": "Limit results to those matching a string.", "schema": { "type": "string" } }, { "name": "slug", "in": "query", "description": "Limit result set to terms with one or more specific slugs.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "A list of tags.", "headers": { "X-WP-Total": { "description": "Total number of matching records.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next / rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/tags/{id}": { "get": { "operationId": "get_tags", "summary": "Retrieve a tag", "description": "Retrieve a single tag by id.", "tags": [ "Tags" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier for the term.", "schema": { "type": "integer" }, "required": true }, { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } } ], "responses": { "200": { "description": "The requested record.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/comments": { "get": { "operationId": "list_comments", "summary": "List comments", "description": "Approved comments. Read-only for anonymous callers; the collection also accepts POST for authenticated editors, which is not documented here.", "tags": [ "Comments" ], "parameters": [ { "name": "after", "in": "query", "description": "Limit response to comments published after a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "author", "in": "query", "description": "Limit result set to comments assigned to specific user IDs. Requires authorization.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "author_email", "in": "query", "description": "Limit result set to that from a specific author email. Requires authorization.", "schema": { "type": "string", "format": "email" } }, { "name": "author_exclude", "in": "query", "description": "Ensure result set excludes comments assigned to specific user IDs. Requires authorization.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "before", "in": "query", "description": "Limit response to comments published before a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } }, { "name": "exclude", "in": "query", "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "include", "in": "query", "description": "Limit result set to specific IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "offset", "in": "query", "description": "Offset the result set by a specific number of items.", "schema": { "type": "integer" } }, { "name": "order", "in": "query", "description": "Order sort attribute ascending or descending.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "orderby", "in": "query", "description": "Sort collection by comment attribute.", "schema": { "type": "string", "enum": [ "date", "date_gmt", "id", "include", "post", "parent", "type" ], "default": "date_gmt" } }, { "name": "page", "in": "query", "description": "Current page of the collection.", "schema": { "type": "integer", "default": 1, "minimum": 1 } }, { "name": "parent", "in": "query", "description": "Limit result set to comments of specific parent IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "parent_exclude", "in": "query", "description": "Ensure result set excludes specific parent IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "password", "in": "query", "description": "The password for the post if it is password protected.", "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "description": "Maximum number of items to be returned in result set.", "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 } }, { "name": "post", "in": "query", "description": "Limit result set to comments assigned to specific post IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "search", "in": "query", "description": "Limit results to those matching a string.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Limit result set to comments assigned a specific status. Requires authorization.", "schema": { "type": "string", "default": "approve" } }, { "name": "type", "in": "query", "description": "Limit result set to comments assigned a specific type. Requires authorization.", "schema": { "type": "string", "default": "comment" } } ], "responses": { "200": { "description": "A list of comments.", "headers": { "X-WP-Total": { "description": "Total number of matching records.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next / rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/comments/{id}": { "get": { "operationId": "get_comments", "summary": "Retrieve a comment", "description": "Retrieve a single comment by id.", "tags": [ "Comments" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier for the comment.", "schema": { "type": "integer" }, "required": true }, { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } }, { "name": "password", "in": "query", "description": "The password for the parent post of the comment (if the post is password protected).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested record.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/search": { "get": { "operationId": "list_search", "summary": "List search", "description": "Cross-content-type search index. Read-only for anonymous callers; the collection also accepts POST for authenticated editors, which is not documented here.", "tags": [ "Search" ], "parameters": [ { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed" ], "default": "view" } }, { "name": "exclude", "in": "query", "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "include", "in": "query", "description": "Limit result set to specific IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "page", "in": "query", "description": "Current page of the collection.", "schema": { "type": "integer", "default": 1, "minimum": 1 } }, { "name": "per_page", "in": "query", "description": "Maximum number of items to be returned in result set.", "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 } }, { "name": "search", "in": "query", "description": "Limit results to those matching a string.", "schema": { "type": "string" } }, { "name": "subtype", "in": "query", "description": "Limit results to items of one or more object subtypes.", "style": "form", "explode": false, "schema": { "type": "array", "default": "any", "items": { "type": "string", "enum": [ "post", "page", "case_study", "popup", "popup_theme", "category", "post_tag", "any" ] } } }, { "name": "type", "in": "query", "description": "Limit results to items of an object type.", "schema": { "type": "string", "enum": [ "post", "term", "post-format" ], "default": "post" } } ], "responses": { "200": { "description": "A list of search.", "headers": { "X-WP-Total": { "description": "Total number of matching records.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next / rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/types": { "get": { "operationId": "list_types", "summary": "List types", "description": "Registered post types. Read-only for anonymous callers; the collection also accepts POST for authenticated editors, which is not documented here.", "tags": [ "Types" ], "parameters": [ { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } } ], "responses": { "200": { "description": "A list of types.", "headers": { "X-WP-Total": { "description": "Total number of matching records.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next / rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/statuses": { "get": { "operationId": "list_statuses", "summary": "List statuses", "description": "Registered post statuses. Read-only for anonymous callers; the collection also accepts POST for authenticated editors, which is not documented here.", "tags": [ "Statuses" ], "parameters": [ { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } } ], "responses": { "200": { "description": "A list of statuses.", "headers": { "X-WP-Total": { "description": "Total number of matching records.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next / rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/taxonomies": { "get": { "operationId": "list_taxonomies", "summary": "List taxonomies", "description": "Registered taxonomies. Read-only for anonymous callers; the collection also accepts POST for authenticated editors, which is not documented here.", "tags": [ "Taxonomies" ], "parameters": [ { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } }, { "name": "type", "in": "query", "description": "Limit results to taxonomies associated with a specific post type.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A list of taxonomies.", "headers": { "X-WP-Total": { "description": "Total number of matching records.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next / rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/case_study": { "get": { "operationId": "list_case_study", "summary": "List case study", "description": "VaynerMedia client case studies (custom post type). Read-only for anonymous callers; the collection also accepts POST for authenticated editors, which is not documented here.", "tags": [ "CaseStudies" ], "parameters": [ { "name": "after", "in": "query", "description": "Limit response to posts published after a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "author", "in": "query", "description": "Limit result set to posts assigned to specific authors.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "author_exclude", "in": "query", "description": "Ensure result set excludes posts assigned to specific authors.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "before", "in": "query", "description": "Limit response to posts published before a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "categories", "in": "query", "description": "Limit result set to items with specific terms assigned in the categories taxonomy.", "schema": { "type": [ "object", "array" ] } }, { "name": "categories_exclude", "in": "query", "description": "Limit result set to items except those with specific terms assigned in the categories taxonomy.", "schema": { "type": [ "object", "array" ] } }, { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } }, { "name": "exclude", "in": "query", "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "include", "in": "query", "description": "Limit result set to specific IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "modified_after", "in": "query", "description": "Limit response to posts modified after a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Limit response to posts modified before a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Offset the result set by a specific number of items.", "schema": { "type": "integer" } }, { "name": "order", "in": "query", "description": "Order sort attribute ascending or descending.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "orderby", "in": "query", "description": "Sort collection by post attribute.", "schema": { "type": "string", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title" ], "default": "date" } }, { "name": "page", "in": "query", "description": "Current page of the collection.", "schema": { "type": "integer", "default": 1, "minimum": 1 } }, { "name": "per_page", "in": "query", "description": "Maximum number of items to be returned in result set.", "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 } }, { "name": "search", "in": "query", "description": "Limit results to those matching a string.", "schema": { "type": "string" } }, { "name": "search_columns", "in": "query", "description": "Array of column names to be searched.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "string", "enum": [ "post_title", "post_content", "post_excerpt" ] } } }, { "name": "search_semantics", "in": "query", "description": "How to interpret the search input.", "schema": { "type": "string", "enum": [ "exact" ] } }, { "name": "slug", "in": "query", "description": "Limit result set to posts with one or more specific slugs.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "status", "in": "query", "description": "Limit result set to posts assigned one or more statuses.", "style": "form", "explode": false, "schema": { "type": "array", "default": "publish", "items": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "email_sent", "email_failed", "email_scheduled", "any" ] } } }, { "name": "tags", "in": "query", "description": "Limit result set to items with specific terms assigned in the tags taxonomy.", "schema": { "type": [ "object", "array" ] } }, { "name": "tags_exclude", "in": "query", "description": "Limit result set to items except those with specific terms assigned in the tags taxonomy.", "schema": { "type": [ "object", "array" ] } }, { "name": "tax_relation", "in": "query", "description": "Limit result set based on relationship between multiple taxonomies.", "schema": { "type": "string", "enum": [ "AND", "OR" ] } } ], "responses": { "200": { "description": "A list of case_study.", "headers": { "X-WP-Total": { "description": "Total number of matching records.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next / rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/case_study/{id}": { "get": { "operationId": "get_case_study", "summary": "Retrieve a case study", "description": "Retrieve a single case study by id.", "tags": [ "CaseStudies" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier for the post.", "schema": { "type": "integer" }, "required": true }, { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } }, { "name": "excerpt_length", "in": "query", "description": "Override the default excerpt length.", "schema": { "type": "integer" } }, { "name": "password", "in": "query", "description": "The password for the post if it is password protected.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested record.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/popups": { "get": { "operationId": "list_popups", "summary": "List popups", "description": "Popup Maker popups (report/download gates). Read-only for anonymous callers; the collection also accepts POST for authenticated editors, which is not documented here.", "tags": [ "Popups" ], "parameters": [ { "name": "after", "in": "query", "description": "Limit response to posts published after a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "author", "in": "query", "description": "Limit result set to posts assigned to specific authors.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "author_exclude", "in": "query", "description": "Ensure result set excludes posts assigned to specific authors.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "before", "in": "query", "description": "Limit response to posts published before a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } }, { "name": "exclude", "in": "query", "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "include", "in": "query", "description": "Limit result set to specific IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "modified_after", "in": "query", "description": "Limit response to posts modified after a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Limit response to posts modified before a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Offset the result set by a specific number of items.", "schema": { "type": "integer" } }, { "name": "order", "in": "query", "description": "Order sort attribute ascending or descending.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "orderby", "in": "query", "description": "Sort collection by post attribute.", "schema": { "type": "string", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title" ], "default": "date" } }, { "name": "page", "in": "query", "description": "Current page of the collection.", "schema": { "type": "integer", "default": 1, "minimum": 1 } }, { "name": "per_page", "in": "query", "description": "Maximum number of items to be returned in result set.", "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 } }, { "name": "search", "in": "query", "description": "Limit results to those matching a string.", "schema": { "type": "string" } }, { "name": "search_columns", "in": "query", "description": "Array of column names to be searched.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "string", "enum": [ "post_title", "post_content", "post_excerpt" ] } } }, { "name": "search_semantics", "in": "query", "description": "How to interpret the search input.", "schema": { "type": "string", "enum": [ "exact" ] } }, { "name": "slug", "in": "query", "description": "Limit result set to posts with one or more specific slugs.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "status", "in": "query", "description": "Limit result set to posts assigned one or more statuses.", "style": "form", "explode": false, "schema": { "type": "array", "default": "publish", "items": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "email_sent", "email_failed", "email_scheduled", "any" ] } } } ], "responses": { "200": { "description": "A list of popups.", "headers": { "X-WP-Total": { "description": "Total number of matching records.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next / rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/popups/{id}": { "get": { "operationId": "get_popups", "summary": "Retrieve a popup", "description": "Retrieve a single popup by id.", "tags": [ "Popups" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier for the post.", "schema": { "type": "integer" }, "required": true }, { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } }, { "name": "excerpt_length", "in": "query", "description": "Override the default excerpt length.", "schema": { "type": "integer" } }, { "name": "password", "in": "query", "description": "The password for the post if it is password protected.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested record.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/popup-themes": { "get": { "operationId": "list_popup_themes", "summary": "List popup-themes", "description": "Popup Maker themes. Read-only for anonymous callers; the collection also accepts POST for authenticated editors, which is not documented here.", "tags": [ "Popups" ], "parameters": [ { "name": "after", "in": "query", "description": "Limit response to posts published after a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "author", "in": "query", "description": "Limit result set to posts assigned to specific authors.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "author_exclude", "in": "query", "description": "Ensure result set excludes posts assigned to specific authors.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "before", "in": "query", "description": "Limit response to posts published before a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } }, { "name": "exclude", "in": "query", "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "include", "in": "query", "description": "Limit result set to specific IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "modified_after", "in": "query", "description": "Limit response to posts modified after a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Limit response to posts modified before a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Offset the result set by a specific number of items.", "schema": { "type": "integer" } }, { "name": "order", "in": "query", "description": "Order sort attribute ascending or descending.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "orderby", "in": "query", "description": "Sort collection by post attribute.", "schema": { "type": "string", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title" ], "default": "date" } }, { "name": "page", "in": "query", "description": "Current page of the collection.", "schema": { "type": "integer", "default": 1, "minimum": 1 } }, { "name": "per_page", "in": "query", "description": "Maximum number of items to be returned in result set.", "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 } }, { "name": "search", "in": "query", "description": "Limit results to those matching a string.", "schema": { "type": "string" } }, { "name": "search_columns", "in": "query", "description": "Array of column names to be searched.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "string", "enum": [ "post_title", "post_content", "post_excerpt" ] } } }, { "name": "search_semantics", "in": "query", "description": "How to interpret the search input.", "schema": { "type": "string", "enum": [ "exact" ] } }, { "name": "slug", "in": "query", "description": "Limit result set to posts with one or more specific slugs.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "status", "in": "query", "description": "Limit result set to posts assigned one or more statuses.", "style": "form", "explode": false, "schema": { "type": "array", "default": "publish", "items": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "email_sent", "email_failed", "email_scheduled", "any" ] } } } ], "responses": { "200": { "description": "A list of popup-themes.", "headers": { "X-WP-Total": { "description": "Total number of matching records.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next / rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/popup-themes/{id}": { "get": { "operationId": "get_popup_themes", "summary": "Retrieve a popup theme", "description": "Retrieve a single popup theme by id.", "tags": [ "Popups" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier for the post.", "schema": { "type": "integer" }, "required": true }, { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } }, { "name": "excerpt_length", "in": "query", "description": "Override the default excerpt length.", "schema": { "type": "integer" } }, { "name": "password", "in": "query", "description": "The password for the post if it is password protected.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested record.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/blocks": { "get": { "operationId": "list_blocks", "summary": "List blocks", "description": "Reusable editor blocks. Read-only for anonymous callers; the collection also accepts POST for authenticated editors, which is not documented here.", "tags": [ "Blocks" ], "parameters": [ { "name": "after", "in": "query", "description": "Limit response to posts published after a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "before", "in": "query", "description": "Limit response to posts published before a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } }, { "name": "exclude", "in": "query", "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "include", "in": "query", "description": "Limit result set to specific IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "modified_after", "in": "query", "description": "Limit response to posts modified after a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Limit response to posts modified before a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Offset the result set by a specific number of items.", "schema": { "type": "integer" } }, { "name": "order", "in": "query", "description": "Order sort attribute ascending or descending.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "orderby", "in": "query", "description": "Sort collection by post attribute.", "schema": { "type": "string", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title" ], "default": "date" } }, { "name": "page", "in": "query", "description": "Current page of the collection.", "schema": { "type": "integer", "default": 1, "minimum": 1 } }, { "name": "per_page", "in": "query", "description": "Maximum number of items to be returned in result set.", "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 } }, { "name": "search", "in": "query", "description": "Limit results to those matching a string.", "schema": { "type": "string" } }, { "name": "search_columns", "in": "query", "description": "Array of column names to be searched.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "string", "enum": [ "post_title", "post_content", "post_excerpt" ] } } }, { "name": "search_semantics", "in": "query", "description": "How to interpret the search input.", "schema": { "type": "string", "enum": [ "exact" ] } }, { "name": "slug", "in": "query", "description": "Limit result set to posts with one or more specific slugs.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "status", "in": "query", "description": "Limit result set to posts assigned one or more statuses.", "style": "form", "explode": false, "schema": { "type": "array", "default": "publish", "items": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "email_sent", "email_failed", "email_scheduled", "any" ] } } }, { "name": "tax_relation", "in": "query", "description": "Limit result set based on relationship between multiple taxonomies.", "schema": { "type": "string", "enum": [ "AND", "OR" ] } }, { "name": "wp_pattern_category", "in": "query", "description": "Limit result set to items with specific terms assigned in the wp_pattern_category taxonomy.", "schema": { "type": [ "object", "array" ] } }, { "name": "wp_pattern_category_exclude", "in": "query", "description": "Limit result set to items except those with specific terms assigned in the wp_pattern_category taxonomy.", "schema": { "type": [ "object", "array" ] } } ], "responses": { "200": { "description": "A list of blocks.", "headers": { "X-WP-Total": { "description": "Total number of matching records.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next / rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/blocks/{id}": { "get": { "operationId": "get_blocks", "summary": "Retrieve a block", "description": "Retrieve a single block by id.", "tags": [ "Blocks" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier for the post.", "schema": { "type": "integer" }, "required": true }, { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } }, { "name": "excerpt_length", "in": "query", "description": "Override the default excerpt length.", "schema": { "type": "integer" } }, { "name": "password", "in": "query", "description": "The password for the post if it is password protected.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested record.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/salient_g_sections": { "get": { "operationId": "list_salient_g_sections", "summary": "List salient g sections", "description": "Salient theme global sections (custom post type). Read-only for anonymous callers; the collection also accepts POST for authenticated editors, which is not documented here.", "tags": [ "Blocks" ], "parameters": [ { "name": "after", "in": "query", "description": "Limit response to posts published after a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "before", "in": "query", "description": "Limit response to posts published before a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } }, { "name": "exclude", "in": "query", "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "include", "in": "query", "description": "Limit result set to specific IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "modified_after", "in": "query", "description": "Limit response to posts modified after a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Limit response to posts modified before a given ISO8601 compliant date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Offset the result set by a specific number of items.", "schema": { "type": "integer" } }, { "name": "order", "in": "query", "description": "Order sort attribute ascending or descending.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "orderby", "in": "query", "description": "Sort collection by post attribute.", "schema": { "type": "string", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title" ], "default": "date" } }, { "name": "page", "in": "query", "description": "Current page of the collection.", "schema": { "type": "integer", "default": 1, "minimum": 1 } }, { "name": "parent", "in": "query", "description": "Limit result set to items with particular parent IDs.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "parent_exclude", "in": "query", "description": "Limit result set to all items except those of a particular parent ID.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "integer" } } }, { "name": "per_page", "in": "query", "description": "Maximum number of items to be returned in result set.", "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 } }, { "name": "search", "in": "query", "description": "Limit results to those matching a string.", "schema": { "type": "string" } }, { "name": "search_columns", "in": "query", "description": "Array of column names to be searched.", "style": "form", "explode": false, "schema": { "type": "array", "default": [], "items": { "type": "string", "enum": [ "post_title", "post_content", "post_excerpt" ] } } }, { "name": "search_semantics", "in": "query", "description": "How to interpret the search input.", "schema": { "type": "string", "enum": [ "exact" ] } }, { "name": "slug", "in": "query", "description": "Limit result set to posts with one or more specific slugs.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "status", "in": "query", "description": "Limit result set to posts assigned one or more statuses.", "style": "form", "explode": false, "schema": { "type": "array", "default": "publish", "items": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "email_sent", "email_failed", "email_scheduled", "any" ] } } } ], "responses": { "200": { "description": "A list of salient_g_sections.", "headers": { "X-WP-Total": { "description": "Total number of matching records.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next / rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/salient_g_sections/{id}": { "get": { "operationId": "get_salient_g_sections", "summary": "Retrieve a global section", "description": "Retrieve a single global section by id.", "tags": [ "Blocks" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier for the post.", "schema": { "type": "integer" }, "required": true }, { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } }, { "name": "password", "in": "query", "description": "The password for the post if it is password protected.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested record.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/types/{type}": { "get": { "operationId": "get_type", "summary": "Retrieve a registered type", "tags": [ "Types" ], "parameters": [ { "name": "type", "in": "path", "required": true, "description": "Identifier of the registered type.", "schema": { "type": "string" } }, { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } } ], "responses": { "200": { "description": "The requested type.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } }, "/wp/v2/statuses/{status}": { "get": { "operationId": "get_status", "summary": "Retrieve a registered status", "tags": [ "Statuses" ], "parameters": [ { "name": "status", "in": "path", "required": true, "description": "Identifier of the registered status.", "schema": { "type": "string" } }, { "name": "context", "in": "query", "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } } ], "responses": { "200": { "description": "The requested status.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "$ref": "#/components/responses/Error" } }, "security": [ {} ] } } }, "components": { "schemas": { "Error": { "type": "object", "description": "WordPress REST API error envelope (WP_Error serialized to JSON).", "properties": { "code": { "type": "string", "description": "Machine-readable error code, e.g. rest_no_route." }, "message": { "type": "string", "description": "Human-readable error message." }, "data": { "type": "object", "properties": { "status": { "type": "integer", "description": "HTTP status code." }, "params": { "type": "object", "description": "Per-parameter validation messages, when present." }, "details": { "type": "object", "description": "Per-parameter error objects, when present." } }, "required": [ "status" ] } }, "required": [ "code", "message" ], "examples": [ { "code": "rest_no_route", "message": "No route was found matching the URL and request method.", "data": { "status": 404 } } ] } }, "responses": { "Error": { "description": "WordPress error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "securitySchemes": { "applicationPassword": { "type": "http", "scheme": "basic", "description": "WordPress Application Passwords. Advertised by the site's own route index (authentication.application-passwords.endpoints.authorization = https://vaynermedia.com/wp-admin/authorize-application.php). Required only for write operations and privileged reads; every operation in this document is callable anonymously." } } }, "security": [] }