{ "opencollection": "1.0.0", "info": { "name": "Offerpad WordPress REST API (wp/v2)", "version": "2.0.0" }, "items": [ { "info": { "name": "index", "type": "folder" }, "items": [ { "info": { "name": "Get the wp/v2 namespace index", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2", "params": [ { "name": "namespace", "value": "", "type": "query" }, { "name": "context", "value": "", "type": "query" } ] }, "docs": "Get the wp/v2 namespace index" } ] }, { "info": { "name": "block-directory", "type": "folder" }, "items": [ { "info": { "name": "List block directory search", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/block-directory/search", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "term", "value": "", "type": "query", "description": "Limit result set to blocks matching the search term." } ] }, "docs": "List block directory search" } ] }, { "info": { "name": "block-patterns", "type": "folder" }, "items": [ { "info": { "name": "List block patterns categories", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/block-patterns/categories" }, "docs": "List block patterns categories" }, { "info": { "name": "List block patterns patterns", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/block-patterns/patterns" }, "docs": "List block patterns patterns" } ] }, { "info": { "name": "block-renderer", "type": "folder" }, "items": [ { "info": { "name": "Retrieve block renderer", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/block-renderer/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Unique registered name for the block." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "attributes", "value": "", "type": "query", "description": "Attributes for the block." }, { "name": "post_id", "value": "", "type": "query", "description": "ID of the post context." } ] }, "docs": "Retrieve block renderer" }, { "info": { "name": "Create block renderer", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/block-renderer/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Unique registered name for the block." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create block renderer" } ] }, { "info": { "name": "block-types", "type": "folder" }, "items": [ { "info": { "name": "List block types", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/block-types", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "namespace", "value": "", "type": "query", "description": "Block namespace." } ] }, "docs": "List block types" }, { "info": { "name": "Retrieve block types", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/block-types/:namespace", "params": [ { "name": "namespace", "value": "", "type": "path", "description": "Block namespace." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve block types" }, { "info": { "name": "Retrieve block types", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/block-types/:namespace/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Block name." }, { "name": "namespace", "value": "", "type": "path", "description": "Block namespace." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve block types" } ] }, { "info": { "name": "blocks", "type": "folder" }, "items": [ { "info": { "name": "List blocks", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/blocks", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "after", "value": "", "type": "query", "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "value": "", "type": "query", "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "before", "value": "", "type": "query", "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "value": "", "type": "query", "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "value": "", "type": "query", "description": "How to interpret the search input." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by post attribute." }, { "name": "search_columns", "value": "", "type": "query", "description": "Array of column names to be searched." }, { "name": "slug", "value": "", "type": "query", "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "value": "", "type": "query", "description": "Limit result set to posts assigned one or more statuses." }, { "name": "tax_relation", "value": "", "type": "query", "description": "Limit result set based on relationship between multiple taxonomies." }, { "name": "wp_pattern_category", "value": "", "type": "query", "description": "Limit result set to items with specific terms assigned in the wp_pattern_category taxonomy." }, { "name": "wp_pattern_category_exclude", "value": "", "type": "query", "description": "Limit result set to items except those with specific terms assigned in the wp_pattern_category taxonomy." } ] }, "docs": "List blocks" }, { "info": { "name": "Create blocks", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/blocks", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create blocks" }, { "info": { "name": "Retrieve blocks", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/blocks/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "excerpt_length", "value": "", "type": "query", "description": "Override the default excerpt length." }, { "name": "password", "value": "", "type": "query", "description": "The password for the post if it is password protected." } ] }, "docs": "Retrieve blocks" }, { "info": { "name": "Create blocks", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/blocks/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create blocks" }, { "info": { "name": "Delete blocks", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/blocks/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." }, { "name": "force", "value": "", "type": "query", "description": "Whether to bypass Trash and force deletion." } ] }, "docs": "Delete blocks" }, { "info": { "name": "Retrieve blocks autosaves", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/blocks/:id/autosaves", "params": [ { "name": "id", "value": "", "type": "path", "description": "Path parameter id declared by the route regex." }, { "name": "parent", "value": "", "type": "query", "description": "The ID for the parent of the autosave." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve blocks autosaves" }, { "info": { "name": "Create blocks autosaves", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/blocks/:id/autosaves", "params": [ { "name": "id", "value": "", "type": "path", "description": "Path parameter id declared by the route regex." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create blocks autosaves" }, { "info": { "name": "Retrieve blocks autosaves", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/blocks/:parent/autosaves/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID for the autosave." }, { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the autosave." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve blocks autosaves" }, { "info": { "name": "Retrieve blocks revisions", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/blocks/:parent/revisions", "params": [ { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the revision." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by object attribute." } ] }, "docs": "Retrieve blocks revisions" }, { "info": { "name": "Retrieve blocks revisions", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/blocks/:parent/revisions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the revision." }, { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the revision." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve blocks revisions" }, { "info": { "name": "Delete blocks revisions", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/blocks/:parent/revisions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the revision." }, { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the revision." }, { "name": "force", "value": "", "type": "query", "description": "Required to be true, as revisions do not support trashing." } ] }, "docs": "Delete blocks revisions" } ] }, { "info": { "name": "categories", "type": "folder" }, "items": [ { "info": { "name": "List categories", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/categories", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by term attribute." }, { "name": "hide_empty", "value": "", "type": "query", "description": "Whether to hide terms not assigned to any posts." }, { "name": "parent", "value": "", "type": "query", "description": "Limit result set to terms assigned to a specific parent." }, { "name": "post", "value": "", "type": "query", "description": "Limit result set to terms assigned to a specific post." }, { "name": "slug", "value": "", "type": "query", "description": "Limit result set to terms with one or more specific slugs." } ] }, "docs": "List categories" }, { "info": { "name": "Create categories", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/categories", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create categories" }, { "info": { "name": "Retrieve categories", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/categories/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the term." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve categories" }, { "info": { "name": "Create categories", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/categories/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the term." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create categories" }, { "info": { "name": "Delete categories", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/categories/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the term." }, { "name": "force", "value": "", "type": "query", "description": "Required to be true, as terms do not support trashing." } ] }, "docs": "Delete categories" } ] }, { "info": { "name": "comments", "type": "folder" }, "items": [ { "info": { "name": "List comments", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/comments", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "after", "value": "", "type": "query", "description": "Limit response to comments published after a given ISO8601 compliant date." }, { "name": "author", "value": "", "type": "query", "description": "Limit result set to comments assigned to specific user IDs. Requires authorization." }, { "name": "author_exclude", "value": "", "type": "query", "description": "Ensure result set excludes comments assigned to specific user IDs. Requires authorization." }, { "name": "author_email", "value": "", "type": "query", "description": "Limit result set to that from a specific author email. Requires authorization." }, { "name": "before", "value": "", "type": "query", "description": "Limit response to comments published before a given ISO8601 compliant date." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by comment attribute." }, { "name": "parent", "value": "", "type": "query", "description": "Limit result set to comments of specific parent IDs." }, { "name": "parent_exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific parent IDs." }, { "name": "post", "value": "", "type": "query", "description": "Limit result set to comments assigned to specific post IDs." }, { "name": "status", "value": "", "type": "query", "description": "Limit result set to comments assigned a specific status. Requires authorization." }, { "name": "type", "value": "", "type": "query", "description": "Limit result set to comments assigned a specific type. Requires authorization." }, { "name": "password", "value": "", "type": "query", "description": "The password for the post if it is password protected." } ] }, "docs": "List comments" }, { "info": { "name": "Create comments", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/comments", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create comments" }, { "info": { "name": "Retrieve comments", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/comments/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the comment." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "password", "value": "", "type": "query", "description": "The password for the parent post of the comment (if the post is password protected)." } ] }, "docs": "Retrieve comments" }, { "info": { "name": "Create comments", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/comments/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the comment." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create comments" }, { "info": { "name": "Delete comments", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/comments/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the comment." }, { "name": "force", "value": "", "type": "query", "description": "Whether to bypass Trash and force deletion." }, { "name": "password", "value": "", "type": "query", "description": "The password for the parent post of the comment (if the post is password protected)." } ] }, "docs": "Delete comments" } ] }, { "info": { "name": "e-floating-buttons", "type": "folder" }, "items": [ { "info": { "name": "List e floating buttons", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/e-floating-buttons", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "after", "value": "", "type": "query", "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "value": "", "type": "query", "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "author", "value": "", "type": "query", "description": "Limit result set to posts assigned to specific authors." }, { "name": "author_exclude", "value": "", "type": "query", "description": "Ensure result set excludes posts assigned to specific authors." }, { "name": "before", "value": "", "type": "query", "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "value": "", "type": "query", "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "menu_order", "value": "", "type": "query", "description": "Limit result set to posts with a specific menu_order value." }, { "name": "search_semantics", "value": "", "type": "query", "description": "How to interpret the search input." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by post attribute." }, { "name": "search_columns", "value": "", "type": "query", "description": "Array of column names to be searched." }, { "name": "slug", "value": "", "type": "query", "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "value": "", "type": "query", "description": "Limit result set to posts assigned one or more statuses." }, { "name": "format", "value": "", "type": "query", "description": "Limit result set to items assigned one or more given formats." } ] }, "docs": "List e floating buttons" }, { "info": { "name": "Create e floating buttons", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/e-floating-buttons", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create e floating buttons" }, { "info": { "name": "Retrieve e floating buttons", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/e-floating-buttons/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "excerpt_length", "value": "", "type": "query", "description": "Override the default excerpt length." }, { "name": "password", "value": "", "type": "query", "description": "The password for the post if it is password protected." } ] }, "docs": "Retrieve e floating buttons" }, { "info": { "name": "Create e floating buttons", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/e-floating-buttons/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create e floating buttons" }, { "info": { "name": "Delete e floating buttons", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/e-floating-buttons/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." }, { "name": "force", "value": "", "type": "query", "description": "Whether to bypass Trash and force deletion." } ] }, "docs": "Delete e floating buttons" }, { "info": { "name": "Retrieve e floating buttons autosaves", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/e-floating-buttons/:id/autosaves", "params": [ { "name": "id", "value": "", "type": "path", "description": "Path parameter id declared by the route regex." }, { "name": "parent", "value": "", "type": "query", "description": "The ID for the parent of the autosave." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve e floating buttons autosaves" }, { "info": { "name": "Create e floating buttons autosaves", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/e-floating-buttons/:id/autosaves", "params": [ { "name": "id", "value": "", "type": "path", "description": "Path parameter id declared by the route regex." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create e floating buttons autosaves" }, { "info": { "name": "Retrieve e floating buttons autosaves", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/e-floating-buttons/:parent/autosaves/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID for the autosave." }, { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the autosave." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve e floating buttons autosaves" }, { "info": { "name": "Retrieve e floating buttons revisions", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/e-floating-buttons/:parent/revisions", "params": [ { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the revision." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by object attribute." } ] }, "docs": "Retrieve e floating buttons revisions" }, { "info": { "name": "Retrieve e floating buttons revisions", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/e-floating-buttons/:parent/revisions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the revision." }, { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the revision." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve e floating buttons revisions" }, { "info": { "name": "Delete e floating buttons revisions", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/e-floating-buttons/:parent/revisions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the revision." }, { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the revision." }, { "name": "force", "value": "", "type": "query", "description": "Required to be true, as revisions do not support trashing." } ] }, "docs": "Delete e floating buttons revisions" } ] }, { "info": { "name": "elementor_library", "type": "folder" }, "items": [ { "info": { "name": "List elementor library", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/elementor_library", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "after", "value": "", "type": "query", "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "value": "", "type": "query", "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "author", "value": "", "type": "query", "description": "Limit result set to posts assigned to specific authors." }, { "name": "author_exclude", "value": "", "type": "query", "description": "Ensure result set excludes posts assigned to specific authors." }, { "name": "before", "value": "", "type": "query", "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "value": "", "type": "query", "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "value": "", "type": "query", "description": "How to interpret the search input." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by post attribute." }, { "name": "search_columns", "value": "", "type": "query", "description": "Array of column names to be searched." }, { "name": "slug", "value": "", "type": "query", "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "value": "", "type": "query", "description": "Limit result set to posts assigned one or more statuses." } ] }, "docs": "List elementor library" }, { "info": { "name": "Create elementor library", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/elementor_library", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create elementor library" }, { "info": { "name": "Retrieve elementor library", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/elementor_library/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "password", "value": "", "type": "query", "description": "The password for the post if it is password protected." } ] }, "docs": "Retrieve elementor library" }, { "info": { "name": "Create elementor library", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/elementor_library/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create elementor library" }, { "info": { "name": "Delete elementor library", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/elementor_library/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." }, { "name": "force", "value": "", "type": "query", "description": "Whether to bypass Trash and force deletion." } ] }, "docs": "Delete elementor library" }, { "info": { "name": "Retrieve elementor library revisions", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/elementor_library/:parent/revisions", "params": [ { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the revision." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by object attribute." } ] }, "docs": "Retrieve elementor library revisions" }, { "info": { "name": "Retrieve elementor library revisions", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/elementor_library/:parent/revisions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the revision." }, { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the revision." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve elementor library revisions" }, { "info": { "name": "Delete elementor library revisions", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/elementor_library/:parent/revisions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the revision." }, { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the revision." }, { "name": "force", "value": "", "type": "query", "description": "Required to be true, as revisions do not support trashing." } ] }, "docs": "Delete elementor library revisions" } ] }, { "info": { "name": "elementor_snippet", "type": "folder" }, "items": [ { "info": { "name": "List elementor snippet", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/elementor_snippet", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "after", "value": "", "type": "query", "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "value": "", "type": "query", "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "author", "value": "", "type": "query", "description": "Limit result set to posts assigned to specific authors." }, { "name": "author_exclude", "value": "", "type": "query", "description": "Ensure result set excludes posts assigned to specific authors." }, { "name": "before", "value": "", "type": "query", "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "value": "", "type": "query", "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "value": "", "type": "query", "description": "How to interpret the search input." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by post attribute." }, { "name": "search_columns", "value": "", "type": "query", "description": "Array of column names to be searched." }, { "name": "slug", "value": "", "type": "query", "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "value": "", "type": "query", "description": "Limit result set to posts assigned one or more statuses." } ] }, "docs": "List elementor snippet" }, { "info": { "name": "Create elementor snippet", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/elementor_snippet", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create elementor snippet" }, { "info": { "name": "Retrieve elementor snippet", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/elementor_snippet/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "password", "value": "", "type": "query", "description": "The password for the post if it is password protected." } ] }, "docs": "Retrieve elementor snippet" }, { "info": { "name": "Create elementor snippet", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/elementor_snippet/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create elementor snippet" }, { "info": { "name": "Delete elementor snippet", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/elementor_snippet/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." }, { "name": "force", "value": "", "type": "query", "description": "Whether to bypass Trash and force deletion." } ] }, "docs": "Delete elementor snippet" } ] }, { "info": { "name": "font-collections", "type": "folder" }, "items": [ { "info": { "name": "List font collections", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/font-collections", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." } ] }, "docs": "List font collections" }, { "info": { "name": "Retrieve font collections", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/font-collections/:slug", "params": [ { "name": "slug", "value": "", "type": "path", "description": "Path parameter slug declared by the route regex." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve font collections" } ] }, { "info": { "name": "font-families", "type": "folder" }, "items": [ { "info": { "name": "List font families", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/font-families", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "value": "", "type": "query", "description": "How to interpret the search input." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by post attribute." }, { "name": "slug", "value": "", "type": "query", "description": "Limit result set to posts with one or more specific slugs." } ] }, "docs": "List font families" }, { "info": { "name": "Create font families", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/font-families", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create font families" }, { "info": { "name": "Retrieve font families font faces", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/font-families/:font_family_id/font-faces", "params": [ { "name": "font_family_id", "value": "", "type": "path", "description": "The ID for the parent font family of the font face." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "value": "", "type": "query", "description": "How to interpret the search input." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by post attribute." } ] }, "docs": "Retrieve font families font faces" }, { "info": { "name": "Create font families font faces", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/font-families/:font_family_id/font-faces", "params": [ { "name": "font_family_id", "value": "", "type": "path", "description": "The ID for the parent font family of the font face." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create font families font faces" }, { "info": { "name": "Retrieve font families font faces", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/font-families/:font_family_id/font-faces/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the font face." }, { "name": "font_family_id", "value": "", "type": "path", "description": "The ID for the parent font family of the font face." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve font families font faces" }, { "info": { "name": "Delete font families font faces", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/font-families/:font_family_id/font-faces/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the font face." }, { "name": "font_family_id", "value": "", "type": "path", "description": "The ID for the parent font family of the font face." }, { "name": "force", "value": "", "type": "query", "description": "Whether to bypass Trash and force deletion." } ] }, "docs": "Delete font families font faces" }, { "info": { "name": "Retrieve font families", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/font-families/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve font families" }, { "info": { "name": "Create font families", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/font-families/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create font families" }, { "info": { "name": "Delete font families", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/font-families/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." }, { "name": "force", "value": "", "type": "query", "description": "Whether to bypass Trash and force deletion." } ] }, "docs": "Delete font families" } ] }, { "info": { "name": "global-styles", "type": "folder" }, "items": [ { "info": { "name": "Retrieve global styles", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/global-styles/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of global styles config." } ] }, "docs": "Retrieve global styles" }, { "info": { "name": "Create global styles", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/global-styles/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Path parameter id declared by the route regex." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create global styles" }, { "info": { "name": "Retrieve global styles revisions", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/global-styles/:parent/revisions", "params": [ { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the revision." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." } ] }, "docs": "Retrieve global styles revisions" }, { "info": { "name": "Retrieve global styles revisions", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/global-styles/:parent/revisions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the global styles revision." }, { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the global styles revision." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve global styles revisions" }, { "info": { "name": "Retrieve global styles themes variations", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/global-styles/themes/:stylesheet/variations", "params": [ { "name": "stylesheet", "value": "", "type": "path", "description": "The theme identifier" } ] }, "docs": "Retrieve global styles themes variations" }, { "info": { "name": "Retrieve global styles themes", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/global-styles/themes/:stylesheet", "params": [ { "name": "stylesheet", "value": "", "type": "path", "description": "The theme identifier" } ] }, "docs": "Retrieve global styles themes" } ] }, { "info": { "name": "icons", "type": "folder" }, "items": [ { "info": { "name": "List icons", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/icons", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." } ] }, "docs": "List icons" }, { "info": { "name": "Retrieve icons", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/icons/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Icon name." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve icons" } ] }, { "info": { "name": "locations", "type": "folder" }, "items": [ { "info": { "name": "List locations", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/locations", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "after", "value": "", "type": "query", "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "value": "", "type": "query", "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "before", "value": "", "type": "query", "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "value": "", "type": "query", "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "value": "", "type": "query", "description": "How to interpret the search input." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by post attribute." }, { "name": "search_columns", "value": "", "type": "query", "description": "Array of column names to be searched." }, { "name": "slug", "value": "", "type": "query", "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "value": "", "type": "query", "description": "Limit result set to posts assigned one or more statuses." }, { "name": "tax_relation", "value": "", "type": "query", "description": "Limit result set based on relationship between multiple taxonomies." }, { "name": "states", "value": "", "type": "query", "description": "Limit result set to items with specific terms assigned in the states taxonomy." }, { "name": "states_exclude", "value": "", "type": "query", "description": "Limit result set to items except those with specific terms assigned in the states taxonomy." } ] }, "docs": "List locations" }, { "info": { "name": "Create locations", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/locations", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create locations" }, { "info": { "name": "Retrieve locations", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/locations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "password", "value": "", "type": "query", "description": "The password for the post if it is password protected." } ] }, "docs": "Retrieve locations" }, { "info": { "name": "Create locations", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/locations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create locations" }, { "info": { "name": "Delete locations", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/locations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." }, { "name": "force", "value": "", "type": "query", "description": "Whether to bypass Trash and force deletion." } ] }, "docs": "Delete locations" }, { "info": { "name": "Retrieve locations autosaves", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/locations/:id/autosaves", "params": [ { "name": "id", "value": "", "type": "path", "description": "Path parameter id declared by the route regex." }, { "name": "parent", "value": "", "type": "query", "description": "The ID for the parent of the autosave." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve locations autosaves" }, { "info": { "name": "Create locations autosaves", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/locations/:id/autosaves", "params": [ { "name": "id", "value": "", "type": "path", "description": "Path parameter id declared by the route regex." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create locations autosaves" }, { "info": { "name": "Retrieve locations autosaves", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/locations/:parent/autosaves/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID for the autosave." }, { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the autosave." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve locations autosaves" } ] }, { "info": { "name": "media", "type": "folder" }, "items": [ { "info": { "name": "List media", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/media", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "after", "value": "", "type": "query", "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "value": "", "type": "query", "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "author", "value": "", "type": "query", "description": "Limit result set to posts assigned to specific authors." }, { "name": "author_exclude", "value": "", "type": "query", "description": "Ensure result set excludes posts assigned to specific authors." }, { "name": "before", "value": "", "type": "query", "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "value": "", "type": "query", "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "value": "", "type": "query", "description": "How to interpret the search input." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by post attribute." }, { "name": "parent", "value": "", "type": "query", "description": "Limit result set to items with particular parent IDs." }, { "name": "parent_exclude", "value": "", "type": "query", "description": "Limit result set to all items except those of a particular parent ID." }, { "name": "search_columns", "value": "", "type": "query", "description": "Array of column names to be searched." }, { "name": "slug", "value": "", "type": "query", "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "value": "", "type": "query", "description": "Limit result set to posts assigned one or more statuses." }, { "name": "media_type", "value": "", "type": "query", "description": "Limit result set to attachments of a particular media type or media types." }, { "name": "mime_type", "value": "", "type": "query", "description": "Limit result set to attachments of a particular MIME type or MIME types." } ] }, "docs": "List media" }, { "info": { "name": "Create media", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/media", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create media" }, { "info": { "name": "Retrieve media", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/media/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve media" }, { "info": { "name": "Create media", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/media/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create media" }, { "info": { "name": "Delete media", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/media/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." }, { "name": "force", "value": "", "type": "query", "description": "Whether to bypass Trash and force deletion." } ] }, "docs": "Delete media" }, { "info": { "name": "Create media edit", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/media/:id/edit", "params": [ { "name": "id", "value": "", "type": "path", "description": "Path parameter id declared by the route regex." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create media edit" }, { "info": { "name": "Create media post process", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/media/:id/post-process", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the attachment." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create media post process" } ] }, { "info": { "name": "menu-items", "type": "folder" }, "items": [ { "info": { "name": "List menu items", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/menu-items", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "after", "value": "", "type": "query", "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "value": "", "type": "query", "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "before", "value": "", "type": "query", "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "value": "", "type": "query", "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "value": "", "type": "query", "description": "How to interpret the search input." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by object attribute." }, { "name": "search_columns", "value": "", "type": "query", "description": "Array of column names to be searched." }, { "name": "slug", "value": "", "type": "query", "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "value": "", "type": "query", "description": "Limit result set to posts assigned one or more statuses." }, { "name": "tax_relation", "value": "", "type": "query", "description": "Limit result set based on relationship between multiple taxonomies." }, { "name": "menus", "value": "", "type": "query", "description": "Limit result set to items with specific terms assigned in the menus taxonomy." }, { "name": "menus_exclude", "value": "", "type": "query", "description": "Limit result set to items except those with specific terms assigned in the menus taxonomy." }, { "name": "menu_order", "value": "", "type": "query", "description": "Limit result set to posts with a specific menu_order value." } ] }, "docs": "List menu items" }, { "info": { "name": "Create menu items", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/menu-items", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create menu items" }, { "info": { "name": "Retrieve menu items", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/menu-items/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve menu items" }, { "info": { "name": "Create menu items", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/menu-items/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create menu items" }, { "info": { "name": "Delete menu items", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/menu-items/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." }, { "name": "force", "value": "", "type": "query", "description": "Whether to bypass Trash and force deletion." } ] }, "docs": "Delete menu items" }, { "info": { "name": "Retrieve menu items autosaves", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/menu-items/:id/autosaves", "params": [ { "name": "id", "value": "", "type": "path", "description": "Path parameter id declared by the route regex." }, { "name": "parent", "value": "", "type": "query", "description": "The ID for the parent of the autosave." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve menu items autosaves" }, { "info": { "name": "Create menu items autosaves", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/menu-items/:id/autosaves", "params": [ { "name": "id", "value": "", "type": "path", "description": "Path parameter id declared by the route regex." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create menu items autosaves" }, { "info": { "name": "Retrieve menu items autosaves", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/menu-items/:parent/autosaves/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID for the autosave." }, { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the autosave." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve menu items autosaves" } ] }, { "info": { "name": "menu-locations", "type": "folder" }, "items": [ { "info": { "name": "List menu locations", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/menu-locations", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "List menu locations" }, { "info": { "name": "Retrieve menu locations", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/menu-locations/:location", "params": [ { "name": "location", "value": "", "type": "path", "description": "An alphanumeric identifier for the menu location." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve menu locations" } ] }, { "info": { "name": "menus", "type": "folder" }, "items": [ { "info": { "name": "List menus", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/menus", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by term attribute." }, { "name": "hide_empty", "value": "", "type": "query", "description": "Whether to hide terms not assigned to any posts." }, { "name": "post", "value": "", "type": "query", "description": "Limit result set to terms assigned to a specific post." }, { "name": "slug", "value": "", "type": "query", "description": "Limit result set to terms with one or more specific slugs." } ] }, "docs": "List menus" }, { "info": { "name": "Create menus", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/menus", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create menus" }, { "info": { "name": "Retrieve menus", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/menus/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the term." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve menus" }, { "info": { "name": "Create menus", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/menus/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the term." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create menus" }, { "info": { "name": "Delete menus", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/menus/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the term." }, { "name": "force", "value": "", "type": "query", "description": "Required to be true, as terms do not support trashing." } ] }, "docs": "Delete menus" } ] }, { "info": { "name": "navigation", "type": "folder" }, "items": [ { "info": { "name": "List navigation", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/navigation", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "after", "value": "", "type": "query", "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "value": "", "type": "query", "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "before", "value": "", "type": "query", "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "value": "", "type": "query", "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "value": "", "type": "query", "description": "How to interpret the search input." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by post attribute." }, { "name": "search_columns", "value": "", "type": "query", "description": "Array of column names to be searched." }, { "name": "slug", "value": "", "type": "query", "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "value": "", "type": "query", "description": "Limit result set to posts assigned one or more statuses." } ] }, "docs": "List navigation" }, { "info": { "name": "Create navigation", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/navigation", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create navigation" }, { "info": { "name": "Retrieve navigation", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/navigation/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "password", "value": "", "type": "query", "description": "The password for the post if it is password protected." } ] }, "docs": "Retrieve navigation" }, { "info": { "name": "Create navigation", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/navigation/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create navigation" }, { "info": { "name": "Delete navigation", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/navigation/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." }, { "name": "force", "value": "", "type": "query", "description": "Whether to bypass Trash and force deletion." } ] }, "docs": "Delete navigation" }, { "info": { "name": "Retrieve navigation autosaves", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/navigation/:id/autosaves", "params": [ { "name": "id", "value": "", "type": "path", "description": "Path parameter id declared by the route regex." }, { "name": "parent", "value": "", "type": "query", "description": "The ID for the parent of the autosave." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve navigation autosaves" }, { "info": { "name": "Create navigation autosaves", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/navigation/:id/autosaves", "params": [ { "name": "id", "value": "", "type": "path", "description": "Path parameter id declared by the route regex." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create navigation autosaves" }, { "info": { "name": "Retrieve navigation autosaves", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/navigation/:parent/autosaves/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID for the autosave." }, { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the autosave." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve navigation autosaves" }, { "info": { "name": "Retrieve navigation revisions", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/navigation/:parent/revisions", "params": [ { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the revision." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by object attribute." } ] }, "docs": "Retrieve navigation revisions" }, { "info": { "name": "Retrieve navigation revisions", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/navigation/:parent/revisions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the revision." }, { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the revision." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve navigation revisions" }, { "info": { "name": "Delete navigation revisions", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/navigation/:parent/revisions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the revision." }, { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the revision." }, { "name": "force", "value": "", "type": "query", "description": "Required to be true, as revisions do not support trashing." } ] }, "docs": "Delete navigation revisions" } ] }, { "info": { "name": "pages", "type": "folder" }, "items": [ { "info": { "name": "List pages", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/pages", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "after", "value": "", "type": "query", "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "value": "", "type": "query", "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "author", "value": "", "type": "query", "description": "Limit result set to posts assigned to specific authors." }, { "name": "author_exclude", "value": "", "type": "query", "description": "Ensure result set excludes posts assigned to specific authors." }, { "name": "before", "value": "", "type": "query", "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "value": "", "type": "query", "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "menu_order", "value": "", "type": "query", "description": "Limit result set to posts with a specific menu_order value." }, { "name": "search_semantics", "value": "", "type": "query", "description": "How to interpret the search input." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by post attribute." }, { "name": "parent", "value": "", "type": "query", "description": "Limit result set to items with particular parent IDs." }, { "name": "parent_exclude", "value": "", "type": "query", "description": "Limit result set to all items except those of a particular parent ID." }, { "name": "search_columns", "value": "", "type": "query", "description": "Array of column names to be searched." }, { "name": "slug", "value": "", "type": "query", "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "value": "", "type": "query", "description": "Limit result set to posts assigned one or more statuses." } ] }, "docs": "List pages" }, { "info": { "name": "Create pages", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/pages", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create pages" }, { "info": { "name": "Retrieve pages", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/pages/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "excerpt_length", "value": "", "type": "query", "description": "Override the default excerpt length." }, { "name": "password", "value": "", "type": "query", "description": "The password for the post if it is password protected." } ] }, "docs": "Retrieve pages" }, { "info": { "name": "Create pages", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/pages/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create pages" }, { "info": { "name": "Delete pages", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/pages/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." }, { "name": "force", "value": "", "type": "query", "description": "Whether to bypass Trash and force deletion." } ] }, "docs": "Delete pages" }, { "info": { "name": "Retrieve pages autosaves", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/pages/:id/autosaves", "params": [ { "name": "id", "value": "", "type": "path", "description": "Path parameter id declared by the route regex." }, { "name": "parent", "value": "", "type": "query", "description": "The ID for the parent of the autosave." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve pages autosaves" }, { "info": { "name": "Create pages autosaves", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/pages/:id/autosaves", "params": [ { "name": "id", "value": "", "type": "path", "description": "Path parameter id declared by the route regex." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create pages autosaves" }, { "info": { "name": "Retrieve pages autosaves", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/pages/:parent/autosaves/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID for the autosave." }, { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the autosave." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve pages autosaves" }, { "info": { "name": "Retrieve pages revisions", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/pages/:parent/revisions", "params": [ { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the revision." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by object attribute." } ] }, "docs": "Retrieve pages revisions" }, { "info": { "name": "Retrieve pages revisions", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/pages/:parent/revisions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the revision." }, { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the revision." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve pages revisions" }, { "info": { "name": "Delete pages revisions", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/pages/:parent/revisions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the revision." }, { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the revision." }, { "name": "force", "value": "", "type": "query", "description": "Required to be true, as revisions do not support trashing." } ] }, "docs": "Delete pages revisions" } ] }, { "info": { "name": "pattern-directory", "type": "folder" }, "items": [ { "info": { "name": "List pattern directory patterns", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/pattern-directory/patterns", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "category", "value": "", "type": "query", "description": "Limit results to those matching a category ID." }, { "name": "keyword", "value": "", "type": "query", "description": "Limit results to those matching a keyword ID." }, { "name": "slug", "value": "", "type": "query", "description": "Limit results to those matching a pattern (slug)." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by post attribute." } ] }, "docs": "List pattern directory patterns" } ] }, { "info": { "name": "plugins", "type": "folder" }, "items": [ { "info": { "name": "List plugins", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/plugins", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "status", "value": "", "type": "query", "description": "Limits results to plugins with the given status." } ] }, "docs": "List plugins" }, { "info": { "name": "Create plugins", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/plugins", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create plugins" }, { "info": { "name": "Retrieve plugins", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/plugins/:plugin", "params": [ { "name": "plugin", "value": "", "type": "path", "description": "Path parameter plugin declared by the route regex." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve plugins" }, { "info": { "name": "Create plugins", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/plugins/:plugin", "params": [ { "name": "plugin", "value": "", "type": "path", "description": "Path parameter plugin declared by the route regex." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create plugins" }, { "info": { "name": "Delete plugins", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/plugins/:plugin", "params": [ { "name": "plugin", "value": "", "type": "path", "description": "Path parameter plugin declared by the route regex." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Delete plugins" } ] }, { "info": { "name": "posts", "type": "folder" }, "items": [ { "info": { "name": "List posts", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/posts", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "after", "value": "", "type": "query", "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "value": "", "type": "query", "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "author", "value": "", "type": "query", "description": "Limit result set to posts assigned to specific authors." }, { "name": "author_exclude", "value": "", "type": "query", "description": "Ensure result set excludes posts assigned to specific authors." }, { "name": "before", "value": "", "type": "query", "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "value": "", "type": "query", "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "value": "", "type": "query", "description": "How to interpret the search input." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by post attribute." }, { "name": "search_columns", "value": "", "type": "query", "description": "Array of column names to be searched." }, { "name": "slug", "value": "", "type": "query", "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "value": "", "type": "query", "description": "Limit result set to posts assigned one or more statuses." }, { "name": "tax_relation", "value": "", "type": "query", "description": "Limit result set based on relationship between multiple taxonomies." }, { "name": "categories", "value": "", "type": "query", "description": "Limit result set to items with specific terms assigned in the categories taxonomy." }, { "name": "categories_exclude", "value": "", "type": "query", "description": "Limit result set to items except those with specific terms assigned in the categories taxonomy." }, { "name": "tags", "value": "", "type": "query", "description": "Limit result set to items with specific terms assigned in the tags taxonomy." }, { "name": "tags_exclude", "value": "", "type": "query", "description": "Limit result set to items except those with specific terms assigned in the tags taxonomy." }, { "name": "sticky", "value": "", "type": "query", "description": "Limit result set to items that are sticky." }, { "name": "ignore_sticky", "value": "", "type": "query", "description": "Whether to ignore sticky posts or not." }, { "name": "format", "value": "", "type": "query", "description": "Limit result set to items assigned one or more given formats." } ] }, "docs": "List posts" }, { "info": { "name": "Create posts", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/posts", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create posts" }, { "info": { "name": "Retrieve posts", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/posts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "excerpt_length", "value": "", "type": "query", "description": "Override the default excerpt length." }, { "name": "password", "value": "", "type": "query", "description": "The password for the post if it is password protected." } ] }, "docs": "Retrieve posts" }, { "info": { "name": "Create posts", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/posts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create posts" }, { "info": { "name": "Delete posts", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/posts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." }, { "name": "force", "value": "", "type": "query", "description": "Whether to bypass Trash and force deletion." } ] }, "docs": "Delete posts" }, { "info": { "name": "Retrieve posts autosaves", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/posts/:id/autosaves", "params": [ { "name": "id", "value": "", "type": "path", "description": "Path parameter id declared by the route regex." }, { "name": "parent", "value": "", "type": "query", "description": "The ID for the parent of the autosave." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve posts autosaves" }, { "info": { "name": "Create posts autosaves", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/posts/:id/autosaves", "params": [ { "name": "id", "value": "", "type": "path", "description": "Path parameter id declared by the route regex." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create posts autosaves" }, { "info": { "name": "Retrieve posts autosaves", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/posts/:parent/autosaves/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID for the autosave." }, { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the autosave." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve posts autosaves" }, { "info": { "name": "Retrieve posts revisions", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/posts/:parent/revisions", "params": [ { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the revision." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by object attribute." } ] }, "docs": "Retrieve posts revisions" }, { "info": { "name": "Retrieve posts revisions", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/posts/:parent/revisions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the revision." }, { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the revision." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve posts revisions" }, { "info": { "name": "Delete posts revisions", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/posts/:parent/revisions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the revision." }, { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the revision." }, { "name": "force", "value": "", "type": "query", "description": "Required to be true, as revisions do not support trashing." } ] }, "docs": "Delete posts revisions" } ] }, { "info": { "name": "review", "type": "folder" }, "items": [ { "info": { "name": "List review", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/review", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "after", "value": "", "type": "query", "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "value": "", "type": "query", "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "author", "value": "", "type": "query", "description": "Limit result set to posts assigned to specific authors." }, { "name": "author_exclude", "value": "", "type": "query", "description": "Ensure result set excludes posts assigned to specific authors." }, { "name": "before", "value": "", "type": "query", "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "value": "", "type": "query", "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "value": "", "type": "query", "description": "How to interpret the search input." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by post attribute." }, { "name": "search_columns", "value": "", "type": "query", "description": "Array of column names to be searched." }, { "name": "slug", "value": "", "type": "query", "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "value": "", "type": "query", "description": "Limit result set to posts assigned one or more statuses." } ] }, "docs": "List review" }, { "info": { "name": "Create review", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/review", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create review" }, { "info": { "name": "Retrieve review", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/review/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "excerpt_length", "value": "", "type": "query", "description": "Override the default excerpt length." }, { "name": "password", "value": "", "type": "query", "description": "The password for the post if it is password protected." } ] }, "docs": "Retrieve review" }, { "info": { "name": "Create review", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/review/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create review" }, { "info": { "name": "Delete review", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/review/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the post." }, { "name": "force", "value": "", "type": "query", "description": "Whether to bypass Trash and force deletion." } ] }, "docs": "Delete review" }, { "info": { "name": "Retrieve review autosaves", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/review/:id/autosaves", "params": [ { "name": "id", "value": "", "type": "path", "description": "Path parameter id declared by the route regex." }, { "name": "parent", "value": "", "type": "query", "description": "The ID for the parent of the autosave." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve review autosaves" }, { "info": { "name": "Create review autosaves", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/review/:id/autosaves", "params": [ { "name": "id", "value": "", "type": "path", "description": "Path parameter id declared by the route regex." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create review autosaves" }, { "info": { "name": "Retrieve review autosaves", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/review/:parent/autosaves/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID for the autosave." }, { "name": "parent", "value": "", "type": "path", "description": "The ID for the parent of the autosave." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve review autosaves" } ] }, { "info": { "name": "search", "type": "folder" }, "items": [ { "info": { "name": "List search", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/search", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "type", "value": "", "type": "query", "description": "Limit results to items of an object type." }, { "name": "subtype", "value": "", "type": "query", "description": "Limit results to items of one or more object subtypes." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." } ] }, "docs": "List search" } ] }, { "info": { "name": "settings", "type": "folder" }, "items": [ { "info": { "name": "List settings", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/settings" }, "docs": "List settings" }, { "info": { "name": "Create settings", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/settings", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create settings" } ] }, { "info": { "name": "sidebars", "type": "folder" }, "items": [ { "info": { "name": "List sidebars", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/sidebars", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "List sidebars" }, { "info": { "name": "Retrieve sidebars", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/sidebars/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of a registered sidebar" }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve sidebars" }, { "info": { "name": "Create sidebars", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/sidebars/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Path parameter id declared by the route regex." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create sidebars" } ] }, { "info": { "name": "states", "type": "folder" }, "items": [ { "info": { "name": "List states", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/states", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by term attribute." }, { "name": "hide_empty", "value": "", "type": "query", "description": "Whether to hide terms not assigned to any posts." }, { "name": "parent", "value": "", "type": "query", "description": "Limit result set to terms assigned to a specific parent." }, { "name": "post", "value": "", "type": "query", "description": "Limit result set to terms assigned to a specific post." }, { "name": "slug", "value": "", "type": "query", "description": "Limit result set to terms with one or more specific slugs." } ] }, "docs": "List states" }, { "info": { "name": "Create states", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/states", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create states" }, { "info": { "name": "Retrieve states", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/states/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the term." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve states" }, { "info": { "name": "Create states", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/states/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the term." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create states" }, { "info": { "name": "Delete states", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/states/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the term." }, { "name": "force", "value": "", "type": "query", "description": "Required to be true, as terms do not support trashing." } ] }, "docs": "Delete states" } ] }, { "info": { "name": "statuses", "type": "folder" }, "items": [ { "info": { "name": "List statuses", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/statuses", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "List statuses" }, { "info": { "name": "Retrieve statuses", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/statuses/:status", "params": [ { "name": "status", "value": "", "type": "path", "description": "An alphanumeric identifier for the status." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve statuses" } ] }, { "info": { "name": "tags", "type": "folder" }, "items": [ { "info": { "name": "List tags", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/tags", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by term attribute." }, { "name": "hide_empty", "value": "", "type": "query", "description": "Whether to hide terms not assigned to any posts." }, { "name": "post", "value": "", "type": "query", "description": "Limit result set to terms assigned to a specific post." }, { "name": "slug", "value": "", "type": "query", "description": "Limit result set to terms with one or more specific slugs." } ] }, "docs": "List tags" }, { "info": { "name": "Create tags", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/tags", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create tags" }, { "info": { "name": "Retrieve tags", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/tags/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the term." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve tags" }, { "info": { "name": "Create tags", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/tags/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the term." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create tags" }, { "info": { "name": "Delete tags", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/tags/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the term." }, { "name": "force", "value": "", "type": "query", "description": "Required to be true, as terms do not support trashing." } ] }, "docs": "Delete tags" } ] }, { "info": { "name": "taxonomies", "type": "folder" }, "items": [ { "info": { "name": "List taxonomies", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/taxonomies", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "type", "value": "", "type": "query", "description": "Limit results to taxonomies associated with a specific post type." } ] }, "docs": "List taxonomies" }, { "info": { "name": "Retrieve taxonomies", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/taxonomies/:taxonomy", "params": [ { "name": "taxonomy", "value": "", "type": "path", "description": "An alphanumeric identifier for the taxonomy." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve taxonomies" } ] }, { "info": { "name": "template-parts", "type": "folder" }, "items": [ { "info": { "name": "List template parts", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/template-parts", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "wp_id", "value": "", "type": "query", "description": "Limit to the specified post id." }, { "name": "area", "value": "", "type": "query", "description": "Limit to the specified template part area." }, { "name": "post_type", "value": "", "type": "query", "description": "Post type to get the templates for." } ] }, "docs": "List template parts" }, { "info": { "name": "Create template parts", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/template-parts", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create template parts" }, { "info": { "name": "Retrieve template parts", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/template-parts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of a template" }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve template parts" }, { "info": { "name": "Create template parts", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/template-parts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of a template" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create template parts" }, { "info": { "name": "Delete template parts", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/template-parts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of a template" }, { "name": "force", "value": "", "type": "query", "description": "Whether to bypass Trash and force deletion." } ] }, "docs": "Delete template parts" }, { "info": { "name": "Retrieve template parts autosaves", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/template-parts/:id/autosaves", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of a template" }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve template parts autosaves" }, { "info": { "name": "Create template parts autosaves", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/template-parts/:id/autosaves", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of a template" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create template parts autosaves" }, { "info": { "name": "Retrieve template parts autosaves", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/template-parts/:parent/autosaves/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID for the autosave." }, { "name": "parent", "value": "", "type": "path", "description": "The id of a template" }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve template parts autosaves" }, { "info": { "name": "Retrieve template parts revisions", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/template-parts/:parent/revisions", "params": [ { "name": "parent", "value": "", "type": "path", "description": "The id of a template" }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by object attribute." } ] }, "docs": "Retrieve template parts revisions" }, { "info": { "name": "Retrieve template parts revisions", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/template-parts/:parent/revisions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the revision." }, { "name": "parent", "value": "", "type": "path", "description": "The id of a template" }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve template parts revisions" }, { "info": { "name": "Delete template parts revisions", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/template-parts/:parent/revisions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the revision." }, { "name": "parent", "value": "", "type": "path", "description": "The id of a template" }, { "name": "force", "value": "", "type": "query", "description": "Required to be true, as revisions do not support trashing." } ] }, "docs": "Delete template parts revisions" }, { "info": { "name": "List template parts lookup", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/template-parts/lookup", "params": [ { "name": "slug", "value": "", "type": "query", "description": "The slug of the template to get the fallback for" }, { "name": "is_custom", "value": "", "type": "query", "description": "Indicates if a template is custom or part of the template hierarchy" }, { "name": "template_prefix", "value": "", "type": "query", "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`" } ] }, "docs": "List template parts lookup" } ] }, { "info": { "name": "templates", "type": "folder" }, "items": [ { "info": { "name": "List templates", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/templates", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "wp_id", "value": "", "type": "query", "description": "Limit to the specified post id." }, { "name": "area", "value": "", "type": "query", "description": "Limit to the specified template part area." }, { "name": "post_type", "value": "", "type": "query", "description": "Post type to get the templates for." } ] }, "docs": "List templates" }, { "info": { "name": "Create templates", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/templates", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create templates" }, { "info": { "name": "Retrieve templates", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/templates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of a template" }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve templates" }, { "info": { "name": "Create templates", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/templates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of a template" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create templates" }, { "info": { "name": "Delete templates", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/templates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of a template" }, { "name": "force", "value": "", "type": "query", "description": "Whether to bypass Trash and force deletion." } ] }, "docs": "Delete templates" }, { "info": { "name": "Retrieve templates autosaves", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/templates/:id/autosaves", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of a template" }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve templates autosaves" }, { "info": { "name": "Create templates autosaves", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/templates/:id/autosaves", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of a template" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create templates autosaves" }, { "info": { "name": "Retrieve templates autosaves", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/templates/:parent/autosaves/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID for the autosave." }, { "name": "parent", "value": "", "type": "path", "description": "The id of a template" }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve templates autosaves" }, { "info": { "name": "Retrieve templates revisions", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/templates/:parent/revisions", "params": [ { "name": "parent", "value": "", "type": "path", "description": "The id of a template" }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by object attribute." } ] }, "docs": "Retrieve templates revisions" }, { "info": { "name": "Retrieve templates revisions", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/templates/:parent/revisions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the revision." }, { "name": "parent", "value": "", "type": "path", "description": "The id of a template" }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve templates revisions" }, { "info": { "name": "Delete templates revisions", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/templates/:parent/revisions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the revision." }, { "name": "parent", "value": "", "type": "path", "description": "The id of a template" }, { "name": "force", "value": "", "type": "query", "description": "Required to be true, as revisions do not support trashing." } ] }, "docs": "Delete templates revisions" }, { "info": { "name": "List templates lookup", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/templates/lookup", "params": [ { "name": "slug", "value": "", "type": "query", "description": "The slug of the template to get the fallback for" }, { "name": "is_custom", "value": "", "type": "query", "description": "Indicates if a template is custom or part of the template hierarchy" }, { "name": "template_prefix", "value": "", "type": "query", "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`" } ] }, "docs": "List templates lookup" } ] }, { "info": { "name": "themes", "type": "folder" }, "items": [ { "info": { "name": "List themes", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/themes", "params": [ { "name": "status", "value": "", "type": "query", "description": "Limit result set to themes assigned one or more statuses." } ] }, "docs": "List themes" }, { "info": { "name": "Retrieve themes", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/themes/:stylesheet", "params": [ { "name": "stylesheet", "value": "", "type": "path", "description": "The theme's stylesheet. This uniquely identifies the theme." } ] }, "docs": "Retrieve themes" } ] }, { "info": { "name": "types", "type": "folder" }, "items": [ { "info": { "name": "List types", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/types", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "List types" }, { "info": { "name": "Retrieve types", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/types/:type", "params": [ { "name": "type", "value": "", "type": "path", "description": "An alphanumeric identifier for the post type." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve types" } ] }, { "info": { "name": "users", "type": "folder" }, "items": [ { "info": { "name": "List users", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/users", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by user attribute." }, { "name": "slug", "value": "", "type": "query", "description": "Limit result set to users with one or more specific slugs." }, { "name": "roles", "value": "", "type": "query", "description": "Limit result set to users matching at least one specific role provided. Accepts csv list or single role." }, { "name": "capabilities", "value": "", "type": "query", "description": "Limit result set to users matching at least one specific capability provided. Accepts csv list or single capability." }, { "name": "who", "value": "", "type": "query", "description": "Limit result set to users who are considered authors." }, { "name": "has_published_posts", "value": "", "type": "query", "description": "Limit result set to users who have published posts." }, { "name": "search_columns", "value": "", "type": "query", "description": "Array of column names to be searched." } ] }, "docs": "List users" }, { "info": { "name": "Create users", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/users", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create users" }, { "info": { "name": "Retrieve users", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the user." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve users" }, { "info": { "name": "Create users", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the user." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create users" }, { "info": { "name": "Delete users", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the user." }, { "name": "force", "value": "", "type": "query", "description": "Required to be true, as users do not support trashing." }, { "name": "reassign", "value": "", "type": "query", "description": "Reassign the deleted user's posts and links to this user ID." } ] }, "docs": "Delete users" }, { "info": { "name": "Retrieve users application passwords", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/users/:user_id/application-passwords", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "Path parameter user_id declared by the route regex." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve users application passwords" }, { "info": { "name": "Create users application passwords", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/users/:user_id/application-passwords", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "Path parameter user_id declared by the route regex." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create users application passwords" }, { "info": { "name": "Delete users application passwords", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/users/:user_id/application-passwords", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "Path parameter user_id declared by the route regex." } ] }, "docs": "Delete users application passwords" }, { "info": { "name": "Retrieve users application passwords", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/users/:user_id/application-passwords/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "Path parameter uuid declared by the route regex." }, { "name": "user_id", "value": "", "type": "path", "description": "Path parameter user_id declared by the route regex." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve users application passwords" }, { "info": { "name": "Create users application passwords", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/users/:user_id/application-passwords/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "Path parameter uuid declared by the route regex." }, { "name": "user_id", "value": "", "type": "path", "description": "Path parameter user_id declared by the route regex." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create users application passwords" }, { "info": { "name": "Delete users application passwords", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/users/:user_id/application-passwords/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "Path parameter uuid declared by the route regex." }, { "name": "user_id", "value": "", "type": "path", "description": "Path parameter user_id declared by the route regex." } ] }, "docs": "Delete users application passwords" }, { "info": { "name": "Retrieve users application passwords introspect", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/users/:user_id/application-passwords/introspect", "params": [ { "name": "user_id", "value": "", "type": "path", "description": "Path parameter user_id declared by the route regex." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve users application passwords introspect" }, { "info": { "name": "List users me", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/users/me", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "List users me" }, { "info": { "name": "Create users me", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/users/me", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create users me" }, { "info": { "name": "Delete users me", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/users/me", "params": [ { "name": "force", "value": "", "type": "query", "description": "Required to be true, as users do not support trashing." }, { "name": "reassign", "value": "", "type": "query", "description": "Reassign the deleted user's posts and links to this user ID." } ] }, "docs": "Delete users me" } ] }, { "info": { "name": "widget-types", "type": "folder" }, "items": [ { "info": { "name": "List widget types", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/widget-types", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "List widget types" }, { "info": { "name": "Retrieve widget types", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/widget-types/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The widget type id." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve widget types" }, { "info": { "name": "Create widget types encode", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/widget-types/:id/encode", "params": [ { "name": "id", "value": "", "type": "path", "description": "The widget type id." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create widget types encode" }, { "info": { "name": "Create widget types render", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/widget-types/:id/render", "params": [ { "name": "id", "value": "", "type": "path", "description": "The widget type id." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create widget types render" } ] }, { "info": { "name": "widgets", "type": "folder" }, "items": [ { "info": { "name": "List widgets", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/widgets", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "sidebar", "value": "", "type": "query", "description": "The sidebar to return widgets for." } ] }, "docs": "List widgets" }, { "info": { "name": "Create widgets", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/widgets", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create widgets" }, { "info": { "name": "Retrieve widgets", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/widgets/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Path parameter id declared by the route regex." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve widgets" }, { "info": { "name": "Create widgets", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/widgets/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the widget." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create widgets" }, { "info": { "name": "Delete widgets", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/widgets/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Path parameter id declared by the route regex." }, { "name": "force", "value": "", "type": "query", "description": "Whether to force removal of the widget, or move it to the inactive sidebar." } ] }, "docs": "Delete widgets" } ] }, { "info": { "name": "wp_pattern_category", "type": "folder" }, "items": [ { "info": { "name": "List wp pattern category", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/wp_pattern_category", "params": [ { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "value": "", "type": "query", "description": "Current page of the collection." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of items to be returned in result set." }, { "name": "search", "value": "", "type": "query", "description": "Limit results to those matching a string." }, { "name": "exclude", "value": "", "type": "query", "description": "Ensure result set excludes specific IDs." }, { "name": "include", "value": "", "type": "query", "description": "Limit result set to specific IDs." }, { "name": "offset", "value": "", "type": "query", "description": "Offset the result set by a specific number of items." }, { "name": "order", "value": "", "type": "query", "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "value": "", "type": "query", "description": "Sort collection by term attribute." }, { "name": "hide_empty", "value": "", "type": "query", "description": "Whether to hide terms not assigned to any posts." }, { "name": "post", "value": "", "type": "query", "description": "Limit result set to terms assigned to a specific post." }, { "name": "slug", "value": "", "type": "query", "description": "Limit result set to terms with one or more specific slugs." } ] }, "docs": "List wp pattern category" }, { "info": { "name": "Create wp pattern category", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/wp_pattern_category", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create wp pattern category" }, { "info": { "name": "Retrieve wp pattern category", "type": "http" }, "http": { "method": "GET", "url": "https://www.offerpad.com/wp-json/wp/v2/wp_pattern_category/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the term." }, { "name": "context", "value": "", "type": "query", "description": "Scope under which the request is made; determines fields present in response." } ] }, "docs": "Retrieve wp pattern category" }, { "info": { "name": "Create wp pattern category", "type": "http" }, "http": { "method": "POST", "url": "https://www.offerpad.com/wp-json/wp/v2/wp_pattern_category/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the term." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create wp pattern category" }, { "info": { "name": "Delete wp pattern category", "type": "http" }, "http": { "method": "DELETE", "url": "https://www.offerpad.com/wp-json/wp/v2/wp_pattern_category/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the term." }, { "name": "force", "value": "", "type": "query", "description": "Required to be true, as terms do not support trashing." } ] }, "docs": "Delete wp pattern category" } ] } ], "bundled": true }