{ "openapi": "3.1.0", "info": { "title": "SynSense Website Content API", "version": "wp/v2", "summary": "Anonymous, read-only content API for synsense.ai — products, partners, offices, awards, open roles and news.", "description": "The public WordPress REST API served by SynSense (formerly aiCTX) at https://www.synsense.ai/wp-json. SynSense publishes no product/developer HTTP API for its neuromorphic processors — its developer surface is a set of open-source Python libraries (Samna, Rockpool, Sinabs) — but the corporate site exposes a live, fully anonymous, machine-readable content API whose custom post types carry real company data: 8 product entries, 59 partners, 48 awards, 6 offices, 10 open roles and 33 news posts (counts observed 2026-09-14 from the X-WP-Total response header).\n\nTHIS DOCUMENT IS DERIVED, NOT PUBLISHED BY THE PROVIDER. Every path, parameter and schema in it was read mechanically from surfaces the provider itself serves: the route index at https://www.synsense.ai/wp-json/ and the per-route JSON Schema returned by an HTTP OPTIONS request against each collection. Nothing here was invented. Only the anonymously readable GET operations are described; the same routes also declare POST/PUT/PATCH/DELETE, which require WordPress authentication (application passwords, authorization endpoint https://www.synsense.ai/wp-admin/authorize-application.php) and were never exercised.", "contact": { "name": "SynSense", "url": "https://www.synsense.ai/contact-2/" }, "license": { "name": "Site content is SynSense's; see Terms of Service", "url": "https://www.synsense.ai/terms-of-service/" } }, "servers": [ { "url": "https://www.synsense.ai/wp-json", "description": "SynSense corporate site, WordPress REST API root" } ], "x-generated-from": "https://www.synsense.ai/wp-json/ route index + HTTP OPTIONS JSON Schema per route", "x-generated-on": "2026-09-14", "x-generated-by": "API Evangelist enrichment pipeline (derived, not provider-published)", "tags": [ { "name": "Discovery", "description": "Self-describing index, content types, taxonomies, statuses and site search." }, { "name": "News", "description": "SynSense news posts." }, { "name": "Content", "description": "Site pages, media attachments and authors." }, { "name": "Taxonomy", "description": "Post categories and tags." }, { "name": "Products", "description": "SynSense product entries and their categories." }, { "name": "Careers", "description": "Open roles at SynSense." }, { "name": "Partners", "description": "SynSense partner organisations and their categories." }, { "name": "Awards", "description": "Awards and recognition." }, { "name": "Company", "description": "Offices and their country/city taxonomies." } ], "paths": { "/wp/v2/posts": { "get": { "operationId": "listPosts", "summary": "List posts", "description": "News posts published on synsense.ai.", "tags": [ "News" ], "security": [], "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "author", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to posts assigned to specific authors.", "style": "form", "explode": false }, { "name": "author_exclude", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes posts assigned to specific authors.", "style": "form", "explode": false }, { "name": "before", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "categories", "in": "query", "required": false, "schema": { "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ] }, "description": "Limit result set to items with specific terms assigned in the categories taxonomy." }, { "name": "categories_exclude", "in": "query", "required": false, "schema": { "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ] }, "description": "Limit result set to items except those with specific terms assigned in the categories taxonomy." }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false }, { "name": "include", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs.", "style": "form", "explode": false }, { "name": "modified_after", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "modified_before", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "required": false, "schema": { "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by post attribute." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "minimum": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "slug", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to posts with one or more specific slugs.", "style": "form", "explode": false }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "acf-disabled", "any" ], "type": "string" }, "x-wp-default": "publish" }, "description": "Limit result set to posts assigned one or more statuses.", "style": "form", "explode": false }, { "name": "sticky", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Limit result set to items that are sticky." }, { "name": "tags", "in": "query", "required": false, "schema": { "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ] }, "description": "Limit result set to items with specific terms assigned in the tags taxonomy." }, { "name": "tags_exclude", "in": "query", "required": false, "schema": { "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] } }, "additionalProperties": false } ] }, "description": "Limit result set to items except those with specific terms assigned in the tags taxonomy." }, { "name": "tax_relation", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "AND", "OR" ] }, "description": "Limit result set based on relationship between multiple taxonomies." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "A page of posts. Total item and page counts are returned in the X-WP-Total and X-WP-TotalPages response headers.", "headers": { "X-WP-Total": { "description": "Total number of items in the collection.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available at the current per_page size.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next, rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Post" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" } } } }, "/wp/v2/posts/{id}": { "get": { "operationId": "getPost", "summary": "Retrieve a post", "description": "Retrieve a single post by id.", "tags": [ "News" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Unique identifier for the post.", "schema": { "type": "integer" } }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "password", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The password for the post if it is password protected." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "The requested post.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Post" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/wp/v2/pages": { "get": { "operationId": "listPages", "summary": "List pages", "description": "Static site pages.", "tags": [ "Content" ], "security": [], "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "author", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to posts assigned to specific authors.", "style": "form", "explode": false }, { "name": "author_exclude", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes posts assigned to specific authors.", "style": "form", "explode": false }, { "name": "before", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false }, { "name": "include", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs.", "style": "form", "explode": false }, { "name": "menu_order", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limit result set to posts with a specific menu_order value." }, { "name": "modified_after", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "modified_before", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "required": false, "schema": { "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order" ] }, "description": "Sort collection by post attribute." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "minimum": 1 }, "description": "Current page of the collection." }, { "name": "parent", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to items with particular parent IDs.", "style": "form", "explode": false }, { "name": "parent_exclude", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to all items except those of a particular parent ID.", "style": "form", "explode": false }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "slug", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to posts with one or more specific slugs.", "style": "form", "explode": false }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "acf-disabled", "any" ], "type": "string" }, "x-wp-default": "publish" }, "description": "Limit result set to posts assigned one or more statuses.", "style": "form", "explode": false }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "A page of pages. Total item and page counts are returned in the X-WP-Total and X-WP-TotalPages response headers.", "headers": { "X-WP-Total": { "description": "Total number of items in the collection.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available at the current per_page size.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next, rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Page" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" } } } }, "/wp/v2/pages/{id}": { "get": { "operationId": "getPage", "summary": "Retrieve a page", "description": "Retrieve a single page by id.", "tags": [ "Content" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Unique identifier for the page.", "schema": { "type": "integer" } }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "password", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The password for the post if it is password protected." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "The requested page.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/wp/v2/media": { "get": { "operationId": "listMedia", "summary": "List media", "description": "Uploaded media attachments (datasheets, images, PDFs).", "tags": [ "Content" ], "security": [], "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "author", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to posts assigned to specific authors.", "style": "form", "explode": false }, { "name": "author_exclude", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes posts assigned to specific authors.", "style": "form", "explode": false }, { "name": "before", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false }, { "name": "include", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs.", "style": "form", "explode": false }, { "name": "media_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "image", "video", "text", "application", "audio" ] }, "description": "Limit result set to attachments of a particular media type." }, { "name": "mime_type", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Limit result set to attachments of a particular MIME type." }, { "name": "modified_after", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "modified_before", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "required": false, "schema": { "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by post attribute." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "minimum": 1 }, "description": "Current page of the collection." }, { "name": "parent", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to items with particular parent IDs.", "style": "form", "explode": false }, { "name": "parent_exclude", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to all items except those of a particular parent ID.", "style": "form", "explode": false }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "slug", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to posts with one or more specific slugs.", "style": "form", "explode": false }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "enum": [ "inherit", "private", "trash" ], "type": "string" }, "x-wp-default": "inherit" }, "description": "Limit result set to posts assigned one or more statuses.", "style": "form", "explode": false }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "A page of media. Total item and page counts are returned in the X-WP-Total and X-WP-TotalPages response headers.", "headers": { "X-WP-Total": { "description": "Total number of items in the collection.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available at the current per_page size.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next, rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MediaItem" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" } } } }, "/wp/v2/media/{id}": { "get": { "operationId": "getMediaItem", "summary": "Retrieve a mediaitem", "description": "Retrieve a single mediaitem by id.", "tags": [ "Content" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Unique identifier for the mediaitem.", "schema": { "type": "integer" } }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "The requested mediaitem.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaItem" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/wp/v2/categories": { "get": { "operationId": "listCategories", "summary": "List categories", "description": "Post categories.", "tags": [ "Taxonomy" ], "security": [], "parameters": [ { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false }, { "name": "hide_empty", "in": "query", "required": false, "schema": { "type": "boolean", "default": false }, "description": "Whether to hide terms not assigned to any posts." }, { "name": "include", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs.", "style": "form", "explode": false }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "required": false, "schema": { "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "include_slugs", "term_group", "description", "count" ] }, "description": "Sort collection by term attribute." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "minimum": 1 }, "description": "Current page of the collection." }, { "name": "parent", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific parent." }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 }, "description": "Maximum number of items to be returned in result set." }, { "name": "post", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific post." }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "slug", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to terms with one or more specific slugs.", "style": "form", "explode": false }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "A page of categories. Total item and page counts are returned in the X-WP-Total and X-WP-TotalPages response headers.", "headers": { "X-WP-Total": { "description": "Total number of items in the collection.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available at the current per_page size.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next, rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" } } } }, "/wp/v2/categories/{id}": { "get": { "operationId": "getCategory", "summary": "Retrieve a category", "description": "Retrieve a single category by id.", "tags": [ "Taxonomy" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Unique identifier for the category.", "schema": { "type": "integer" } }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "The requested category.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/wp/v2/tags": { "get": { "operationId": "listTags", "summary": "List tags", "description": "Post tags.", "tags": [ "Taxonomy" ], "security": [], "parameters": [ { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false }, { "name": "hide_empty", "in": "query", "required": false, "schema": { "type": "boolean", "default": false }, "description": "Whether to hide terms not assigned to any posts." }, { "name": "include", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs.", "style": "form", "explode": false }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "required": false, "schema": { "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "include_slugs", "term_group", "description", "count" ] }, "description": "Sort collection by term attribute." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "minimum": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 }, "description": "Maximum number of items to be returned in result set." }, { "name": "post", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific post." }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "slug", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to terms with one or more specific slugs.", "style": "form", "explode": false }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "A page of tags. Total item and page counts are returned in the X-WP-Total and X-WP-TotalPages response headers.", "headers": { "X-WP-Total": { "description": "Total number of items in the collection.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available at the current per_page size.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next, rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" } } } }, "/wp/v2/tags/{id}": { "get": { "operationId": "getTag", "summary": "Retrieve a tag", "description": "Retrieve a single tag by id.", "tags": [ "Taxonomy" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Unique identifier for the tag.", "schema": { "type": "integer" } }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "The requested tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tag" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/wp/v2/products_list": { "get": { "operationId": "listProducts", "summary": "List products", "description": "SynSense product entries (Speck, Xylo, DYNAP-CNN, DVS, Rockpool, Sinabs, Samna...).", "tags": [ "Products" ], "security": [], "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "before", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false }, { "name": "include", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs.", "style": "form", "explode": false }, { "name": "modified_after", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "modified_before", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "required": false, "schema": { "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by post attribute." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "minimum": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 }, "description": "Maximum number of items to be returned in result set." }, { "name": "product_category", "in": "query", "required": false, "schema": { "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ] }, "description": "Limit result set to items with specific terms assigned in the product_category taxonomy." }, { "name": "product_category_exclude", "in": "query", "required": false, "schema": { "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ] }, "description": "Limit result set to items except those with specific terms assigned in the product_category taxonomy." }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "slug", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to posts with one or more specific slugs.", "style": "form", "explode": false }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "acf-disabled", "any" ], "type": "string" }, "x-wp-default": "publish" }, "description": "Limit result set to posts assigned one or more statuses.", "style": "form", "explode": false }, { "name": "tax_relation", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "AND", "OR" ] }, "description": "Limit result set based on relationship between multiple taxonomies." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "A page of products. Total item and page counts are returned in the X-WP-Total and X-WP-TotalPages response headers.", "headers": { "X-WP-Total": { "description": "Total number of items in the collection.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available at the current per_page size.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next, rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" } } } }, "/wp/v2/products_list/{id}": { "get": { "operationId": "getProduct", "summary": "Retrieve a product", "description": "Retrieve a single product by id.", "tags": [ "Products" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Unique identifier for the product.", "schema": { "type": "integer" } }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "password", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The password for the post if it is password protected." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "The requested product.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/wp/v2/product_category": { "get": { "operationId": "listProductCategories", "summary": "List productcategories", "description": "Product categories.", "tags": [ "Products" ], "security": [], "parameters": [ { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false }, { "name": "hide_empty", "in": "query", "required": false, "schema": { "type": "boolean", "default": false }, "description": "Whether to hide terms not assigned to any posts." }, { "name": "include", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs.", "style": "form", "explode": false }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "required": false, "schema": { "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "include_slugs", "term_group", "description", "count" ] }, "description": "Sort collection by term attribute." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "minimum": 1 }, "description": "Current page of the collection." }, { "name": "parent", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific parent." }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 }, "description": "Maximum number of items to be returned in result set." }, { "name": "post", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific post." }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "slug", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to terms with one or more specific slugs.", "style": "form", "explode": false }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "A page of productcategories. Total item and page counts are returned in the X-WP-Total and X-WP-TotalPages response headers.", "headers": { "X-WP-Total": { "description": "Total number of items in the collection.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available at the current per_page size.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next, rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductCategory" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" } } } }, "/wp/v2/product_category/{id}": { "get": { "operationId": "getProductCategory", "summary": "Retrieve a productcategory", "description": "Retrieve a single productcategory by id.", "tags": [ "Products" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Unique identifier for the productcategory.", "schema": { "type": "integer" } }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "The requested productcategory.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCategory" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/wp/v2/careers_list": { "get": { "operationId": "listJobs", "summary": "List jobs", "description": "Open roles at SynSense.", "tags": [ "Careers" ], "security": [], "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "before", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "city", "in": "query", "required": false, "schema": { "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ] }, "description": "Limit result set to items with specific terms assigned in the city taxonomy." }, { "name": "city_exclude", "in": "query", "required": false, "schema": { "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ] }, "description": "Limit result set to items except those with specific terms assigned in the city taxonomy." }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "country", "in": "query", "required": false, "schema": { "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ] }, "description": "Limit result set to items with specific terms assigned in the country taxonomy." }, { "name": "country_exclude", "in": "query", "required": false, "schema": { "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ] }, "description": "Limit result set to items except those with specific terms assigned in the country taxonomy." }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false }, { "name": "include", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs.", "style": "form", "explode": false }, { "name": "modified_after", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "modified_before", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "office", "in": "query", "required": false, "schema": { "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ] }, "description": "Limit result set to items with specific terms assigned in the office taxonomy." }, { "name": "office_exclude", "in": "query", "required": false, "schema": { "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ] }, "description": "Limit result set to items except those with specific terms assigned in the office taxonomy." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "required": false, "schema": { "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by post attribute." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "minimum": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "slug", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to posts with one or more specific slugs.", "style": "form", "explode": false }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "acf-disabled", "any" ], "type": "string" }, "x-wp-default": "publish" }, "description": "Limit result set to posts assigned one or more statuses.", "style": "form", "explode": false }, { "name": "tax_relation", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "AND", "OR" ] }, "description": "Limit result set based on relationship between multiple taxonomies." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "A page of jobs. Total item and page counts are returned in the X-WP-Total and X-WP-TotalPages response headers.", "headers": { "X-WP-Total": { "description": "Total number of items in the collection.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available at the current per_page size.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next, rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Job" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" } } } }, "/wp/v2/careers_list/{id}": { "get": { "operationId": "getJob", "summary": "Retrieve a job", "description": "Retrieve a single job by id.", "tags": [ "Careers" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Unique identifier for the job.", "schema": { "type": "integer" } }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "password", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The password for the post if it is password protected." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "The requested job.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/wp/v2/our_partners": { "get": { "operationId": "listPartners", "summary": "List partners", "description": "SynSense partner organisations.", "tags": [ "Partners" ], "security": [], "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "before", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false }, { "name": "include", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs.", "style": "form", "explode": false }, { "name": "modified_after", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "modified_before", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "required": false, "schema": { "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by post attribute." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "minimum": 1 }, "description": "Current page of the collection." }, { "name": "partners_category", "in": "query", "required": false, "schema": { "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ] }, "description": "Limit result set to items with specific terms assigned in the partners_category taxonomy." }, { "name": "partners_category_exclude", "in": "query", "required": false, "schema": { "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ] }, "description": "Limit result set to items except those with specific terms assigned in the partners_category taxonomy." }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "slug", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to posts with one or more specific slugs.", "style": "form", "explode": false }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "acf-disabled", "any" ], "type": "string" }, "x-wp-default": "publish" }, "description": "Limit result set to posts assigned one or more statuses.", "style": "form", "explode": false }, { "name": "tax_relation", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "AND", "OR" ] }, "description": "Limit result set based on relationship between multiple taxonomies." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "A page of partners. Total item and page counts are returned in the X-WP-Total and X-WP-TotalPages response headers.", "headers": { "X-WP-Total": { "description": "Total number of items in the collection.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available at the current per_page size.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next, rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Partner" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" } } } }, "/wp/v2/our_partners/{id}": { "get": { "operationId": "getPartner", "summary": "Retrieve a partner", "description": "Retrieve a single partner by id.", "tags": [ "Partners" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Unique identifier for the partner.", "schema": { "type": "integer" } }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "password", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The password for the post if it is password protected." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "The requested partner.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Partner" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/wp/v2/partners_category": { "get": { "operationId": "listPartnerCategories", "summary": "List partnercategories", "description": "Partner categories.", "tags": [ "Partners" ], "security": [], "parameters": [ { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false }, { "name": "hide_empty", "in": "query", "required": false, "schema": { "type": "boolean", "default": false }, "description": "Whether to hide terms not assigned to any posts." }, { "name": "include", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs.", "style": "form", "explode": false }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "required": false, "schema": { "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "include_slugs", "term_group", "description", "count" ] }, "description": "Sort collection by term attribute." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "minimum": 1 }, "description": "Current page of the collection." }, { "name": "parent", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific parent." }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 }, "description": "Maximum number of items to be returned in result set." }, { "name": "post", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific post." }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "slug", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to terms with one or more specific slugs.", "style": "form", "explode": false }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "A page of partnercategories. Total item and page counts are returned in the X-WP-Total and X-WP-TotalPages response headers.", "headers": { "X-WP-Total": { "description": "Total number of items in the collection.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available at the current per_page size.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next, rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerCategory" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" } } } }, "/wp/v2/partners_category/{id}": { "get": { "operationId": "getPartnerCategory", "summary": "Retrieve a partnercategory", "description": "Retrieve a single partnercategory by id.", "tags": [ "Partners" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Unique identifier for the partnercategory.", "schema": { "type": "integer" } }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "The requested partnercategory.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCategory" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/wp/v2/awards": { "get": { "operationId": "listAwards", "summary": "List awards", "description": "Awards and recognition entries.", "tags": [ "Awards" ], "security": [], "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "awards_year", "in": "query", "required": false, "schema": { "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false }, "operator": { "description": "Whether items must be assigned all or any of the specified terms.", "type": "string", "enum": [ "AND", "OR" ], "default": "OR" } }, "additionalProperties": false } ] }, "description": "Limit result set to items with specific terms assigned in the awards_year taxonomy." }, { "name": "awards_year_exclude", "in": "query", "required": false, "schema": { "oneOf": [ { "title": "Term ID List", "description": "Match terms with the listed IDs.", "type": "array", "items": { "type": "integer" } }, { "title": "Term ID Taxonomy Query", "description": "Perform an advanced term query.", "type": "object", "properties": { "terms": { "description": "Term IDs.", "type": "array", "items": { "type": "integer" }, "default": [] }, "include_children": { "description": "Whether to include child terms in the terms limiting the result set.", "type": "boolean", "default": false } }, "additionalProperties": false } ] }, "description": "Limit result set to items except those with specific terms assigned in the awards_year taxonomy." }, { "name": "before", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false }, { "name": "include", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs.", "style": "form", "explode": false }, { "name": "modified_after", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "modified_before", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "required": false, "schema": { "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by post attribute." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "minimum": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "slug", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to posts with one or more specific slugs.", "style": "form", "explode": false }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "acf-disabled", "any" ], "type": "string" }, "x-wp-default": "publish" }, "description": "Limit result set to posts assigned one or more statuses.", "style": "form", "explode": false }, { "name": "tax_relation", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "AND", "OR" ] }, "description": "Limit result set based on relationship between multiple taxonomies." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "A page of awards. Total item and page counts are returned in the X-WP-Total and X-WP-TotalPages response headers.", "headers": { "X-WP-Total": { "description": "Total number of items in the collection.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available at the current per_page size.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next, rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Award" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" } } } }, "/wp/v2/awards/{id}": { "get": { "operationId": "getAward", "summary": "Retrieve a award", "description": "Retrieve a single award by id.", "tags": [ "Awards" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Unique identifier for the award.", "schema": { "type": "integer" } }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "password", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The password for the post if it is password protected." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "The requested award.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Award" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/wp/v2/awards_year": { "get": { "operationId": "listAwardYears", "summary": "List awardyears", "description": "Award year taxonomy.", "tags": [ "Awards" ], "security": [], "parameters": [ { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false }, { "name": "hide_empty", "in": "query", "required": false, "schema": { "type": "boolean", "default": false }, "description": "Whether to hide terms not assigned to any posts." }, { "name": "include", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs.", "style": "form", "explode": false }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "required": false, "schema": { "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "include_slugs", "term_group", "description", "count" ] }, "description": "Sort collection by term attribute." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "minimum": 1 }, "description": "Current page of the collection." }, { "name": "parent", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific parent." }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 }, "description": "Maximum number of items to be returned in result set." }, { "name": "post", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific post." }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "slug", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to terms with one or more specific slugs.", "style": "form", "explode": false }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "A page of awardyears. Total item and page counts are returned in the X-WP-Total and X-WP-TotalPages response headers.", "headers": { "X-WP-Total": { "description": "Total number of items in the collection.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available at the current per_page size.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next, rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AwardYear" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" } } } }, "/wp/v2/awards_year/{id}": { "get": { "operationId": "getAwardYear", "summary": "Retrieve a awardyear", "description": "Retrieve a single awardyear by id.", "tags": [ "Awards" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Unique identifier for the awardyear.", "schema": { "type": "integer" } }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "The requested awardyear.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AwardYear" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/wp/v2/office": { "get": { "operationId": "listOffices", "summary": "List offices", "description": "SynSense office locations.", "tags": [ "Company" ], "security": [], "parameters": [ { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false }, { "name": "hide_empty", "in": "query", "required": false, "schema": { "type": "boolean", "default": false }, "description": "Whether to hide terms not assigned to any posts." }, { "name": "include", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs.", "style": "form", "explode": false }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "required": false, "schema": { "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "include_slugs", "term_group", "description", "count" ] }, "description": "Sort collection by term attribute." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "minimum": 1 }, "description": "Current page of the collection." }, { "name": "parent", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific parent." }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 }, "description": "Maximum number of items to be returned in result set." }, { "name": "post", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific post." }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "slug", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to terms with one or more specific slugs.", "style": "form", "explode": false }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "A page of offices. Total item and page counts are returned in the X-WP-Total and X-WP-TotalPages response headers.", "headers": { "X-WP-Total": { "description": "Total number of items in the collection.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available at the current per_page size.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next, rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Office" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" } } } }, "/wp/v2/office/{id}": { "get": { "operationId": "getOffice", "summary": "Retrieve a office", "description": "Retrieve a single office by id.", "tags": [ "Company" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Unique identifier for the office.", "schema": { "type": "integer" } }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "The requested office.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Office" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/wp/v2/country": { "get": { "operationId": "listCountries", "summary": "List countries", "description": "Country taxonomy used by offices.", "tags": [ "Company" ], "security": [], "parameters": [ { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false }, { "name": "hide_empty", "in": "query", "required": false, "schema": { "type": "boolean", "default": false }, "description": "Whether to hide terms not assigned to any posts." }, { "name": "include", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs.", "style": "form", "explode": false }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "required": false, "schema": { "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "include_slugs", "term_group", "description", "count" ] }, "description": "Sort collection by term attribute." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "minimum": 1 }, "description": "Current page of the collection." }, { "name": "parent", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific parent." }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 }, "description": "Maximum number of items to be returned in result set." }, { "name": "post", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific post." }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "slug", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to terms with one or more specific slugs.", "style": "form", "explode": false }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "A page of countries. Total item and page counts are returned in the X-WP-Total and X-WP-TotalPages response headers.", "headers": { "X-WP-Total": { "description": "Total number of items in the collection.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available at the current per_page size.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next, rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Country" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" } } } }, "/wp/v2/country/{id}": { "get": { "operationId": "getCountry", "summary": "Retrieve a country", "description": "Retrieve a single country by id.", "tags": [ "Company" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Unique identifier for the country.", "schema": { "type": "integer" } }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "The requested country.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Country" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/wp/v2/city": { "get": { "operationId": "listCities", "summary": "List cities", "description": "City taxonomy used by offices.", "tags": [ "Company" ], "security": [], "parameters": [ { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false }, { "name": "hide_empty", "in": "query", "required": false, "schema": { "type": "boolean", "default": false }, "description": "Whether to hide terms not assigned to any posts." }, { "name": "include", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs.", "style": "form", "explode": false }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "required": false, "schema": { "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "include_slugs", "term_group", "description", "count" ] }, "description": "Sort collection by term attribute." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "minimum": 1 }, "description": "Current page of the collection." }, { "name": "parent", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific parent." }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 }, "description": "Maximum number of items to be returned in result set." }, { "name": "post", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific post." }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "slug", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to terms with one or more specific slugs.", "style": "form", "explode": false }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "A page of cities. Total item and page counts are returned in the X-WP-Total and X-WP-TotalPages response headers.", "headers": { "X-WP-Total": { "description": "Total number of items in the collection.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available at the current per_page size.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next, rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/City" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" } } } }, "/wp/v2/city/{id}": { "get": { "operationId": "getCity", "summary": "Retrieve a city", "description": "Retrieve a single city by id.", "tags": [ "Company" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Unique identifier for the city.", "schema": { "type": "integer" } }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "The requested city.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/City" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/wp/v2/types": { "get": { "operationId": "listTypes", "summary": "List types", "description": "Registered content types.", "tags": [ "Discovery" ], "security": [], "parameters": [ { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "A page of types. Total item and page counts are returned in the X-WP-Total and X-WP-TotalPages response headers.", "headers": { "X-WP-Total": { "description": "Total number of items in the collection.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available at the current per_page size.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next, rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Type" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" } } } }, "/wp/v2/types/{type}": { "get": { "operationId": "getType", "summary": "Retrieve a type", "description": "Retrieve a single type by type.", "tags": [ "Discovery" ], "security": [], "parameters": [ { "name": "type", "in": "path", "required": true, "description": "Unique identifier for the type.", "schema": { "type": "string" } }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "The requested type.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Type" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/wp/v2/taxonomies": { "get": { "operationId": "listTaxonomies", "summary": "List taxonomies", "description": "Registered taxonomies.", "tags": [ "Discovery" ], "security": [], "parameters": [ { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Limit results to taxonomies associated with a specific post type." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "A page of taxonomies. Total item and page counts are returned in the X-WP-Total and X-WP-TotalPages response headers.", "headers": { "X-WP-Total": { "description": "Total number of items in the collection.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available at the current per_page size.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next, rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Taxonomy" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" } } } }, "/wp/v2/taxonomies/{taxonomy}": { "get": { "operationId": "getTaxonomy", "summary": "Retrieve a taxonomy", "description": "Retrieve a single taxonomy by taxonomy.", "tags": [ "Discovery" ], "security": [], "parameters": [ { "name": "taxonomy", "in": "path", "required": true, "description": "Unique identifier for the taxonomy.", "schema": { "type": "string" } }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "The requested taxonomy.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Taxonomy" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/wp/v2/statuses": { "get": { "operationId": "listStatuses", "summary": "List statuses", "description": "Registered post statuses.", "tags": [ "Discovery" ], "security": [], "parameters": [ { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "A page of statuses. Total item and page counts are returned in the X-WP-Total and X-WP-TotalPages response headers.", "headers": { "X-WP-Total": { "description": "Total number of items in the collection.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available at the current per_page size.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next, rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Status" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" } } } }, "/wp/v2/statuses/{status}": { "get": { "operationId": "getStatus", "summary": "Retrieve a status", "description": "Retrieve a single status by status.", "tags": [ "Discovery" ], "security": [], "parameters": [ { "name": "status", "in": "path", "required": true, "description": "Unique identifier for the status.", "schema": { "type": "string" } }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "The requested status.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/wp/v2/search": { "get": { "operationId": "listSearchResults", "summary": "List searchresults", "description": "Site-wide search across public content.", "tags": [ "Discovery" ], "security": [], "parameters": [ { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false }, { "name": "include", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs.", "style": "form", "explode": false }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "minimum": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "subtype", "in": "query", "required": false, "schema": { "type": "array", "items": { "enum": [ "post", "page", "our_partners", "awards", "products_list", "careers_list", "epkb_post_type_1", "category", "post_tag", "partners_category", "awards_year", "product_category", "country", "city", "office", "epkb_post_type_1_category", "epkb_post_type_1_tag", "any" ], "type": "string" }, "x-wp-default": "any" }, "description": "Limit results to items of one or more object subtypes.", "style": "form", "explode": false }, { "name": "type", "in": "query", "required": false, "schema": { "default": "post", "type": "string", "enum": [ "post", "term", "post-format" ] }, "description": "Limit results to items of an object type." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "A page of searchresults. Total item and page counts are returned in the X-WP-Total and X-WP-TotalPages response headers.", "headers": { "X-WP-Total": { "description": "Total number of items in the collection.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available at the current per_page size.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next, rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SearchResult" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" } } } }, "/wp/v2/users": { "get": { "operationId": "listUsers", "summary": "List users", "description": "Public authors of site content.", "tags": [ "Content" ], "security": [], "parameters": [ { "name": "capabilities", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to users matching at least one specific capability provided. Accepts csv list or single capability.", "style": "form", "explode": false }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs.", "style": "form", "explode": false }, { "name": "has_published_posts", "in": "query", "required": false, "schema": { "type": [ "boolean", "array" ], "items": { "type": "string", "enum": [ "post", "page", "attachment", "nav_menu_item", "wp_block", "wp_template", "wp_template_part", "wp_navigation", "our_partners", "awards", "products_list", "careers_list", "epkb_post_type_1" ] } }, "description": "Limit result set to users who have published posts." }, { "name": "include", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs.", "style": "form", "explode": false }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "required": false, "schema": { "default": "asc", "enum": [ "asc", "desc" ], "type": "string" }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "required": false, "schema": { "default": "name", "enum": [ "id", "include", "name", "registered_date", "slug", "include_slugs", "email", "url" ], "type": "string" }, "description": "Sort collection by user attribute." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "minimum": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 }, "description": "Maximum number of items to be returned in result set." }, { "name": "roles", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to users matching at least one specific role provided. Accepts csv list or single role.", "style": "form", "explode": false }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "slug", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to users with one or more specific slugs.", "style": "form", "explode": false }, { "name": "who", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "authors" ] }, "description": "Limit result set to users who are considered authors." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "A page of users. Total item and page counts are returned in the X-WP-Total and X-WP-TotalPages response headers.", "headers": { "X-WP-Total": { "description": "Total number of items in the collection.", "schema": { "type": "integer" } }, "X-WP-TotalPages": { "description": "Total number of pages available at the current per_page size.", "schema": { "type": "integer" } }, "Link": { "description": "RFC 8288 pagination links (rel=next, rel=prev).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" } } } }, "/wp/v2/users/{id}": { "get": { "operationId": "getUser", "summary": "Retrieve a user", "description": "Retrieve a single user by id.", "tags": [ "Content" ], "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Unique identifier for the user.", "schema": { "type": "integer" } }, { "name": "context", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "wpml_language", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "zh-hans", "en" ] }, "description": "WPML's language code" } ], "responses": { "200": { "description": "The requested user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/": { "get": { "operationId": "getApiIndex", "summary": "Retrieve the API route index", "description": "Self-describing discovery document: site name, description, registered namespaces, every route with its methods and argument schemas, and the supported authentication mechanisms.", "tags": [ "Discovery" ], "security": [], "parameters": [ { "name": "context", "in": "query", "required": false, "description": "Scope under which the request is made; determines fields present in response.", "schema": { "type": "string", "enum": [ "view", "embed", "edit" ], "default": "view" } }, { "name": "namespace", "in": "query", "required": false, "description": "Limit the index to a single namespace, e.g. wp/v2.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The route index.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiIndex" } } } } } } } }, "components": { "schemas": { "Post": { "type": "object", "properties": { "date": { "description": "The date the post was published, in the site's timezone.", "type": [ "string", "null" ], "format": "date-time" }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time" }, "guid": { "description": "The globally unique identifier for the post.", "type": "object", "properties": { "raw": { "description": "GUID for the post, as it exists in the database.", "type": "string" }, "rendered": { "description": "GUID for the post, transformed for display.", "type": "string" } } }, "id": { "description": "Unique identifier for the post.", "type": "integer" }, "link": { "description": "URL to the post.", "type": "string", "format": "uri" }, "modified": { "description": "The date the post was last modified, in the site's timezone.", "type": "string", "format": "date-time" }, "modified_gmt": { "description": "The date the post was last modified, as GMT.", "type": "string", "format": "date-time" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, "status": { "description": "A named status for the post.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "acf-disabled" ] }, "type": { "description": "Type of post.", "type": "string" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, "permalink_template": { "description": "Permalink template for the post.", "type": "string" }, "generated_slug": { "description": "Slug automatically generated from the post title.", "type": "string" }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the post, as it exists in the database.", "type": "string" }, "rendered": { "description": "HTML title for the post, transformed for display.", "type": "string" } } }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string" }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer" }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean" } } }, "author": { "description": "The ID for the author of the post.", "type": "integer" }, "excerpt": { "description": "The excerpt for the post.", "type": "object", "properties": { "raw": { "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { "description": "HTML excerpt for the post, transformed for display.", "type": "string" }, "protected": { "description": "Whether the excerpt is protected with a password.", "type": "boolean" } } }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, "comment_status": { "description": "Whether or not comments are open on the post.", "type": "string", "enum": [ "open", "closed" ] }, "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string", "enum": [ "open", "closed" ] }, "format": { "description": "The format for the post.", "type": "string", "enum": [ "standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio" ] }, "meta": { "description": "Meta fields.", "type": "object", "properties": { "content-type": { "type": "string", "description": "", "default": "" }, "_mi_skip_tracking": { "type": "boolean", "description": "", "default": false } } }, "sticky": { "description": "Whether or not the post should be treated as sticky.", "type": "boolean" }, "template": { "description": "The theme file to use to display the post.", "type": "string" }, "categories": { "description": "The terms assigned to the post in the category taxonomy.", "type": "array", "items": { "type": "integer" } }, "tags": { "description": "The terms assigned to the post in the post_tag taxonomy.", "type": "array", "items": { "type": "integer" } }, "acf": { "description": "ACF field data", "type": "object", "properties": {} } }, "links": [ { "rel": "https://api.w.org/action-publish", "title": "The current user can publish this post.", "href": "https://www.synsense.ai/wp-json/wp/v2/posts/{id}", "targetSchema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "publish", "future" ] } } } }, { "rel": "https://api.w.org/action-unfiltered-html", "title": "The current user can post unfiltered HTML markup and JavaScript.", "href": "https://www.synsense.ai/wp-json/wp/v2/posts/{id}", "targetSchema": { "type": "object", "properties": { "content": { "raw": { "type": "string" } } } } }, { "rel": "https://api.w.org/action-sticky", "title": "The current user can sticky this post.", "href": "https://www.synsense.ai/wp-json/wp/v2/posts/{id}", "targetSchema": { "type": "object", "properties": { "sticky": { "type": "boolean" } } } }, { "rel": "https://api.w.org/action-assign-author", "title": "The current user can change the author on this post.", "href": "https://www.synsense.ai/wp-json/wp/v2/posts/{id}", "targetSchema": { "type": "object", "properties": { "author": { "type": "integer" } } } }, { "rel": "https://api.w.org/action-assign-categories", "title": "The current user can assign terms in the category taxonomy.", "href": "https://www.synsense.ai/wp-json/wp/v2/posts/{id}", "targetSchema": { "type": "object", "properties": { "categories": { "type": "array", "items": { "type": "integer" } } } } }, { "rel": "https://api.w.org/action-create-categories", "title": "The current user can create terms in the category taxonomy.", "href": "https://www.synsense.ai/wp-json/wp/v2/posts/{id}", "targetSchema": { "type": "object", "properties": { "categories": { "type": "array", "items": { "type": "integer" } } } } }, { "rel": "https://api.w.org/action-assign-tags", "title": "The current user can assign terms in the post_tag taxonomy.", "href": "https://www.synsense.ai/wp-json/wp/v2/posts/{id}", "targetSchema": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "integer" } } } } }, { "rel": "https://api.w.org/action-create-tags", "title": "The current user can create terms in the post_tag taxonomy.", "href": "https://www.synsense.ai/wp-json/wp/v2/posts/{id}", "targetSchema": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "integer" } } } } } ] }, "Page": { "type": "object", "properties": { "date": { "description": "The date the post was published, in the site's timezone.", "type": [ "string", "null" ], "format": "date-time" }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time" }, "guid": { "description": "The globally unique identifier for the post.", "type": "object", "properties": { "raw": { "description": "GUID for the post, as it exists in the database.", "type": "string" }, "rendered": { "description": "GUID for the post, transformed for display.", "type": "string" } } }, "id": { "description": "Unique identifier for the post.", "type": "integer" }, "link": { "description": "URL to the post.", "type": "string", "format": "uri" }, "modified": { "description": "The date the post was last modified, in the site's timezone.", "type": "string", "format": "date-time" }, "modified_gmt": { "description": "The date the post was last modified, as GMT.", "type": "string", "format": "date-time" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, "status": { "description": "A named status for the post.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "acf-disabled" ] }, "type": { "description": "Type of post.", "type": "string" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, "permalink_template": { "description": "Permalink template for the post.", "type": "string" }, "generated_slug": { "description": "Slug automatically generated from the post title.", "type": "string" }, "parent": { "description": "The ID for the parent of the post.", "type": "integer" }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the post, as it exists in the database.", "type": "string" }, "rendered": { "description": "HTML title for the post, transformed for display.", "type": "string" } } }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string" }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer" }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean" } } }, "author": { "description": "The ID for the author of the post.", "type": "integer" }, "excerpt": { "description": "The excerpt for the post.", "type": "object", "properties": { "raw": { "description": "Excerpt for the post, as it exists in the database.", "type": "string" }, "rendered": { "description": "HTML excerpt for the post, transformed for display.", "type": "string" }, "protected": { "description": "Whether the excerpt is protected with a password.", "type": "boolean" } } }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, "comment_status": { "description": "Whether or not comments are open on the post.", "type": "string", "enum": [ "open", "closed" ] }, "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string", "enum": [ "open", "closed" ] }, "menu_order": { "description": "The order of the post in relation to other posts.", "type": "integer" }, "meta": { "description": "Meta fields.", "type": "object", "properties": { "content-type": { "type": "string", "description": "", "default": "" }, "_mi_skip_tracking": { "type": "boolean", "description": "", "default": false } } }, "template": { "description": "The theme file to use to display the post.", "type": "string" }, "acf": { "description": "ACF field data", "type": "object", "properties": {} } }, "links": [ { "rel": "https://api.w.org/action-publish", "title": "The current user can publish this post.", "href": "https://www.synsense.ai/wp-json/wp/v2/pages/{id}", "targetSchema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "publish", "future" ] } } } }, { "rel": "https://api.w.org/action-unfiltered-html", "title": "The current user can post unfiltered HTML markup and JavaScript.", "href": "https://www.synsense.ai/wp-json/wp/v2/pages/{id}", "targetSchema": { "type": "object", "properties": { "content": { "raw": { "type": "string" } } } } }, { "rel": "https://api.w.org/action-assign-author", "title": "The current user can change the author on this post.", "href": "https://www.synsense.ai/wp-json/wp/v2/pages/{id}", "targetSchema": { "type": "object", "properties": { "author": { "type": "integer" } } } } ] }, "MediaItem": { "type": "object", "properties": { "date": { "description": "The date the post was published, in the site's timezone.", "type": [ "string", "null" ], "format": "date-time" }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time" }, "guid": { "description": "The globally unique identifier for the post.", "type": "object", "properties": { "raw": { "description": "GUID for the post, as it exists in the database.", "type": "string" }, "rendered": { "description": "GUID for the post, transformed for display.", "type": "string" } } }, "id": { "description": "Unique identifier for the post.", "type": "integer" }, "link": { "description": "URL to the post.", "type": "string", "format": "uri" }, "modified": { "description": "The date the post was last modified, in the site's timezone.", "type": "string", "format": "date-time" }, "modified_gmt": { "description": "The date the post was last modified, as GMT.", "type": "string", "format": "date-time" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, "status": { "description": "A named status for the post.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "acf-disabled" ] }, "type": { "description": "Type of post.", "type": "string" }, "permalink_template": { "description": "Permalink template for the post.", "type": "string" }, "generated_slug": { "description": "Slug automatically generated from the post title.", "type": "string" }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the post, as it exists in the database.", "type": "string" }, "rendered": { "description": "HTML title for the post, transformed for display.", "type": "string" } } }, "author": { "description": "The ID for the author of the post.", "type": "integer" }, "comment_status": { "description": "Whether or not comments are open on the post.", "type": "string", "enum": [ "open", "closed" ] }, "ping_status": { "description": "Whether or not the post can be pinged.", "type": "string", "enum": [ "open", "closed" ] }, "meta": { "description": "Meta fields.", "type": "object", "properties": { "content-type": { "type": "string", "description": "", "default": "" }, "_mi_skip_tracking": { "type": "boolean", "description": "", "default": false } } }, "template": { "description": "The theme file to use to display the post.", "type": "string" }, "acf": { "description": "ACF field data", "type": "object", "properties": {} }, "alt_text": { "description": "Alternative text to display when attachment is not displayed.", "type": "string" }, "caption": { "description": "The attachment caption.", "type": "object", "properties": { "raw": { "description": "Caption for the attachment, as it exists in the database.", "type": "string" }, "rendered": { "description": "HTML caption for the attachment, transformed for display.", "type": "string" } } }, "description": { "description": "The attachment description.", "type": "object", "properties": { "raw": { "description": "Description for the attachment, as it exists in the database.", "type": "string" }, "rendered": { "description": "HTML description for the attachment, transformed for display.", "type": "string" } } }, "media_type": { "description": "Attachment type.", "type": "string", "enum": [ "image", "file" ] }, "mime_type": { "description": "The attachment MIME type.", "type": "string" }, "media_details": { "description": "Details about the media file, specific to its type.", "type": "object" }, "post": { "description": "The ID for the associated post of the attachment.", "type": "integer" }, "source_url": { "description": "URL to the original attachment file.", "type": "string", "format": "uri" }, "missing_image_sizes": { "description": "List of the missing image sizes of the attachment.", "type": "array", "items": { "type": "string" } } }, "links": [ { "rel": "https://api.w.org/action-unfiltered-html", "title": "The current user can post unfiltered HTML markup and JavaScript.", "href": "https://www.synsense.ai/wp-json/wp/v2/media/{id}", "targetSchema": { "type": "object", "properties": { "content": { "raw": { "type": "string" } } } } }, { "rel": "https://api.w.org/action-assign-author", "title": "The current user can change the author on this post.", "href": "https://www.synsense.ai/wp-json/wp/v2/media/{id}", "targetSchema": { "type": "object", "properties": { "author": { "type": "integer" } } } } ] }, "Category": { "type": "object", "properties": { "id": { "description": "Unique identifier for the term.", "type": "integer" }, "count": { "description": "Number of published posts for the term.", "type": "integer" }, "description": { "description": "HTML description of the term.", "type": "string" }, "link": { "description": "URL of the term.", "type": "string", "format": "uri" }, "name": { "description": "HTML title for the term.", "type": "string" }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" }, "taxonomy": { "description": "Type attribution for the term.", "type": "string", "enum": [ "category" ] }, "parent": { "description": "The parent term ID.", "type": "integer" }, "meta": { "description": "Meta fields.", "type": "object", "properties": {} }, "acf": { "description": "ACF field data", "type": "object", "properties": {} } }, "required": [ "name" ] }, "Tag": { "type": "object", "properties": { "id": { "description": "Unique identifier for the term.", "type": "integer" }, "count": { "description": "Number of published posts for the term.", "type": "integer" }, "description": { "description": "HTML description of the term.", "type": "string" }, "link": { "description": "URL of the term.", "type": "string", "format": "uri" }, "name": { "description": "HTML title for the term.", "type": "string" }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" }, "taxonomy": { "description": "Type attribution for the term.", "type": "string", "enum": [ "post_tag" ] }, "meta": { "description": "Meta fields.", "type": "object", "properties": {} } }, "required": [ "name" ] }, "Product": { "type": "object", "properties": { "date": { "description": "The date the post was published, in the site's timezone.", "type": [ "string", "null" ], "format": "date-time" }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time" }, "guid": { "description": "The globally unique identifier for the post.", "type": "object", "properties": { "raw": { "description": "GUID for the post, as it exists in the database.", "type": "string" }, "rendered": { "description": "GUID for the post, transformed for display.", "type": "string" } } }, "id": { "description": "Unique identifier for the post.", "type": "integer" }, "link": { "description": "URL to the post.", "type": "string", "format": "uri" }, "modified": { "description": "The date the post was last modified, in the site's timezone.", "type": "string", "format": "date-time" }, "modified_gmt": { "description": "The date the post was last modified, as GMT.", "type": "string", "format": "date-time" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, "status": { "description": "A named status for the post.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "acf-disabled" ] }, "type": { "description": "Type of post.", "type": "string" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, "permalink_template": { "description": "Permalink template for the post.", "type": "string" }, "generated_slug": { "description": "Slug automatically generated from the post title.", "type": "string" }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the post, as it exists in the database.", "type": "string" }, "rendered": { "description": "HTML title for the post, transformed for display.", "type": "string" } } }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string" }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer" }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean" } } }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, "template": { "description": "The theme file to use to display the post.", "type": "string" }, "product_category": { "description": "The terms assigned to the post in the product_category taxonomy.", "type": "array", "items": { "type": "integer" } }, "acf": { "description": "ACF field data", "type": "object", "properties": {} } }, "links": [ { "rel": "https://api.w.org/action-publish", "title": "The current user can publish this post.", "href": "https://www.synsense.ai/wp-json/wp/v2/products_list/{id}", "targetSchema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "publish", "future" ] } } } }, { "rel": "https://api.w.org/action-unfiltered-html", "title": "The current user can post unfiltered HTML markup and JavaScript.", "href": "https://www.synsense.ai/wp-json/wp/v2/products_list/{id}", "targetSchema": { "type": "object", "properties": { "content": { "raw": { "type": "string" } } } } }, { "rel": "https://api.w.org/action-assign-product_category", "title": "The current user can assign terms in the product_category taxonomy.", "href": "https://www.synsense.ai/wp-json/wp/v2/products_list/{id}", "targetSchema": { "type": "object", "properties": { "product_category": { "type": "array", "items": { "type": "integer" } } } } }, { "rel": "https://api.w.org/action-create-product_category", "title": "The current user can create terms in the product_category taxonomy.", "href": "https://www.synsense.ai/wp-json/wp/v2/products_list/{id}", "targetSchema": { "type": "object", "properties": { "product_category": { "type": "array", "items": { "type": "integer" } } } } } ] }, "ProductCategory": { "type": "object", "properties": { "id": { "description": "Unique identifier for the term.", "type": "integer" }, "count": { "description": "Number of published posts for the term.", "type": "integer" }, "description": { "description": "HTML description of the term.", "type": "string" }, "link": { "description": "URL of the term.", "type": "string", "format": "uri" }, "name": { "description": "HTML title for the term.", "type": "string" }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" }, "taxonomy": { "description": "Type attribution for the term.", "type": "string", "enum": [ "product_category" ] }, "parent": { "description": "The parent term ID.", "type": "integer" }, "meta": { "description": "Meta fields.", "type": "object", "properties": {} }, "acf": { "description": "ACF field data", "type": "object", "properties": {} } }, "required": [ "name" ] }, "Job": { "type": "object", "properties": { "date": { "description": "The date the post was published, in the site's timezone.", "type": [ "string", "null" ], "format": "date-time" }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time" }, "guid": { "description": "The globally unique identifier for the post.", "type": "object", "properties": { "raw": { "description": "GUID for the post, as it exists in the database.", "type": "string" }, "rendered": { "description": "GUID for the post, transformed for display.", "type": "string" } } }, "id": { "description": "Unique identifier for the post.", "type": "integer" }, "link": { "description": "URL to the post.", "type": "string", "format": "uri" }, "modified": { "description": "The date the post was last modified, in the site's timezone.", "type": "string", "format": "date-time" }, "modified_gmt": { "description": "The date the post was last modified, as GMT.", "type": "string", "format": "date-time" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, "status": { "description": "A named status for the post.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "acf-disabled" ] }, "type": { "description": "Type of post.", "type": "string" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the post, as it exists in the database.", "type": "string" }, "rendered": { "description": "HTML title for the post, transformed for display.", "type": "string" } } }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string" }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer" }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean" } } }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, "template": { "description": "The theme file to use to display the post.", "type": "string" }, "country": { "description": "The terms assigned to the post in the country taxonomy.", "type": "array", "items": { "type": "integer" } }, "city": { "description": "The terms assigned to the post in the city taxonomy.", "type": "array", "items": { "type": "integer" } }, "office": { "description": "The terms assigned to the post in the office taxonomy.", "type": "array", "items": { "type": "integer" } }, "acf": { "description": "ACF field data", "type": "object", "properties": {} } }, "links": [ { "rel": "https://api.w.org/action-publish", "title": "The current user can publish this post.", "href": "https://www.synsense.ai/wp-json/wp/v2/careers_list/{id}", "targetSchema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "publish", "future" ] } } } }, { "rel": "https://api.w.org/action-unfiltered-html", "title": "The current user can post unfiltered HTML markup and JavaScript.", "href": "https://www.synsense.ai/wp-json/wp/v2/careers_list/{id}", "targetSchema": { "type": "object", "properties": { "content": { "raw": { "type": "string" } } } } }, { "rel": "https://api.w.org/action-assign-country", "title": "The current user can assign terms in the country taxonomy.", "href": "https://www.synsense.ai/wp-json/wp/v2/careers_list/{id}", "targetSchema": { "type": "object", "properties": { "country": { "type": "array", "items": { "type": "integer" } } } } }, { "rel": "https://api.w.org/action-create-country", "title": "The current user can create terms in the country taxonomy.", "href": "https://www.synsense.ai/wp-json/wp/v2/careers_list/{id}", "targetSchema": { "type": "object", "properties": { "country": { "type": "array", "items": { "type": "integer" } } } } }, { "rel": "https://api.w.org/action-assign-city", "title": "The current user can assign terms in the city taxonomy.", "href": "https://www.synsense.ai/wp-json/wp/v2/careers_list/{id}", "targetSchema": { "type": "object", "properties": { "city": { "type": "array", "items": { "type": "integer" } } } } }, { "rel": "https://api.w.org/action-create-city", "title": "The current user can create terms in the city taxonomy.", "href": "https://www.synsense.ai/wp-json/wp/v2/careers_list/{id}", "targetSchema": { "type": "object", "properties": { "city": { "type": "array", "items": { "type": "integer" } } } } }, { "rel": "https://api.w.org/action-assign-office", "title": "The current user can assign terms in the office taxonomy.", "href": "https://www.synsense.ai/wp-json/wp/v2/careers_list/{id}", "targetSchema": { "type": "object", "properties": { "office": { "type": "array", "items": { "type": "integer" } } } } }, { "rel": "https://api.w.org/action-create-office", "title": "The current user can create terms in the office taxonomy.", "href": "https://www.synsense.ai/wp-json/wp/v2/careers_list/{id}", "targetSchema": { "type": "object", "properties": { "office": { "type": "array", "items": { "type": "integer" } } } } } ] }, "Partner": { "type": "object", "properties": { "date": { "description": "The date the post was published, in the site's timezone.", "type": [ "string", "null" ], "format": "date-time" }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time" }, "guid": { "description": "The globally unique identifier for the post.", "type": "object", "properties": { "raw": { "description": "GUID for the post, as it exists in the database.", "type": "string" }, "rendered": { "description": "GUID for the post, transformed for display.", "type": "string" } } }, "id": { "description": "Unique identifier for the post.", "type": "integer" }, "link": { "description": "URL to the post.", "type": "string", "format": "uri" }, "modified": { "description": "The date the post was last modified, in the site's timezone.", "type": "string", "format": "date-time" }, "modified_gmt": { "description": "The date the post was last modified, as GMT.", "type": "string", "format": "date-time" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, "status": { "description": "A named status for the post.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "acf-disabled" ] }, "type": { "description": "Type of post.", "type": "string" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the post, as it exists in the database.", "type": "string" }, "rendered": { "description": "HTML title for the post, transformed for display.", "type": "string" } } }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string" }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer" }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean" } } }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, "template": { "description": "The theme file to use to display the post.", "type": "string" }, "partners_category": { "description": "The terms assigned to the post in the partners_category taxonomy.", "type": "array", "items": { "type": "integer" } }, "acf": { "description": "ACF field data", "type": "object", "properties": {} } }, "links": [ { "rel": "https://api.w.org/action-publish", "title": "The current user can publish this post.", "href": "https://www.synsense.ai/wp-json/wp/v2/our_partners/{id}", "targetSchema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "publish", "future" ] } } } }, { "rel": "https://api.w.org/action-unfiltered-html", "title": "The current user can post unfiltered HTML markup and JavaScript.", "href": "https://www.synsense.ai/wp-json/wp/v2/our_partners/{id}", "targetSchema": { "type": "object", "properties": { "content": { "raw": { "type": "string" } } } } }, { "rel": "https://api.w.org/action-assign-partners_category", "title": "The current user can assign terms in the partners_category taxonomy.", "href": "https://www.synsense.ai/wp-json/wp/v2/our_partners/{id}", "targetSchema": { "type": "object", "properties": { "partners_category": { "type": "array", "items": { "type": "integer" } } } } }, { "rel": "https://api.w.org/action-create-partners_category", "title": "The current user can create terms in the partners_category taxonomy.", "href": "https://www.synsense.ai/wp-json/wp/v2/our_partners/{id}", "targetSchema": { "type": "object", "properties": { "partners_category": { "type": "array", "items": { "type": "integer" } } } } } ] }, "PartnerCategory": { "type": "object", "properties": { "id": { "description": "Unique identifier for the term.", "type": "integer" }, "count": { "description": "Number of published posts for the term.", "type": "integer" }, "description": { "description": "HTML description of the term.", "type": "string" }, "link": { "description": "URL of the term.", "type": "string", "format": "uri" }, "name": { "description": "HTML title for the term.", "type": "string" }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" }, "taxonomy": { "description": "Type attribution for the term.", "type": "string", "enum": [ "partners_category" ] }, "parent": { "description": "The parent term ID.", "type": "integer" }, "meta": { "description": "Meta fields.", "type": "object", "properties": {} }, "acf": { "description": "ACF field data", "type": "object", "properties": {} } }, "required": [ "name" ] }, "Award": { "type": "object", "properties": { "date": { "description": "The date the post was published, in the site's timezone.", "type": [ "string", "null" ], "format": "date-time" }, "date_gmt": { "description": "The date the post was published, as GMT.", "type": [ "string", "null" ], "format": "date-time" }, "guid": { "description": "The globally unique identifier for the post.", "type": "object", "properties": { "raw": { "description": "GUID for the post, as it exists in the database.", "type": "string" }, "rendered": { "description": "GUID for the post, transformed for display.", "type": "string" } } }, "id": { "description": "Unique identifier for the post.", "type": "integer" }, "link": { "description": "URL to the post.", "type": "string", "format": "uri" }, "modified": { "description": "The date the post was last modified, in the site's timezone.", "type": "string", "format": "date-time" }, "modified_gmt": { "description": "The date the post was last modified, as GMT.", "type": "string", "format": "date-time" }, "slug": { "description": "An alphanumeric identifier for the post unique to its type.", "type": "string" }, "status": { "description": "A named status for the post.", "type": "string", "enum": [ "publish", "future", "draft", "pending", "private", "acf-disabled" ] }, "type": { "description": "Type of post.", "type": "string" }, "password": { "description": "A password to protect access to the content and excerpt.", "type": "string" }, "title": { "description": "The title for the post.", "type": "object", "properties": { "raw": { "description": "Title for the post, as it exists in the database.", "type": "string" }, "rendered": { "description": "HTML title for the post, transformed for display.", "type": "string" } } }, "content": { "description": "The content for the post.", "type": "object", "properties": { "raw": { "description": "Content for the post, as it exists in the database.", "type": "string" }, "rendered": { "description": "HTML content for the post, transformed for display.", "type": "string" }, "block_version": { "description": "Version of the content block format used by the post.", "type": "integer" }, "protected": { "description": "Whether the content is protected with a password.", "type": "boolean" } } }, "featured_media": { "description": "The ID of the featured media for the post.", "type": "integer" }, "template": { "description": "The theme file to use to display the post.", "type": "string" }, "awards_year": { "description": "The terms assigned to the post in the awards_year taxonomy.", "type": "array", "items": { "type": "integer" } }, "acf": { "description": "ACF field data", "type": "object", "properties": {} } }, "links": [ { "rel": "https://api.w.org/action-publish", "title": "The current user can publish this post.", "href": "https://www.synsense.ai/wp-json/wp/v2/awards/{id}", "targetSchema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "publish", "future" ] } } } }, { "rel": "https://api.w.org/action-unfiltered-html", "title": "The current user can post unfiltered HTML markup and JavaScript.", "href": "https://www.synsense.ai/wp-json/wp/v2/awards/{id}", "targetSchema": { "type": "object", "properties": { "content": { "raw": { "type": "string" } } } } }, { "rel": "https://api.w.org/action-assign-awards_year", "title": "The current user can assign terms in the awards_year taxonomy.", "href": "https://www.synsense.ai/wp-json/wp/v2/awards/{id}", "targetSchema": { "type": "object", "properties": { "awards_year": { "type": "array", "items": { "type": "integer" } } } } }, { "rel": "https://api.w.org/action-create-awards_year", "title": "The current user can create terms in the awards_year taxonomy.", "href": "https://www.synsense.ai/wp-json/wp/v2/awards/{id}", "targetSchema": { "type": "object", "properties": { "awards_year": { "type": "array", "items": { "type": "integer" } } } } } ] }, "AwardYear": { "type": "object", "properties": { "id": { "description": "Unique identifier for the term.", "type": "integer" }, "count": { "description": "Number of published posts for the term.", "type": "integer" }, "description": { "description": "HTML description of the term.", "type": "string" }, "link": { "description": "URL of the term.", "type": "string", "format": "uri" }, "name": { "description": "HTML title for the term.", "type": "string" }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" }, "taxonomy": { "description": "Type attribution for the term.", "type": "string", "enum": [ "awards_year" ] }, "parent": { "description": "The parent term ID.", "type": "integer" }, "meta": { "description": "Meta fields.", "type": "object", "properties": {} }, "acf": { "description": "ACF field data", "type": "object", "properties": {} } }, "required": [ "name" ] }, "Office": { "type": "object", "properties": { "id": { "description": "Unique identifier for the term.", "type": "integer" }, "count": { "description": "Number of published posts for the term.", "type": "integer" }, "description": { "description": "HTML description of the term.", "type": "string" }, "link": { "description": "URL of the term.", "type": "string", "format": "uri" }, "name": { "description": "HTML title for the term.", "type": "string" }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" }, "taxonomy": { "description": "Type attribution for the term.", "type": "string", "enum": [ "office" ] }, "parent": { "description": "The parent term ID.", "type": "integer" }, "meta": { "description": "Meta fields.", "type": "object", "properties": {} }, "acf": { "description": "ACF field data", "type": "object", "properties": {} } }, "required": [ "name" ] }, "Country": { "type": "object", "properties": { "id": { "description": "Unique identifier for the term.", "type": "integer" }, "count": { "description": "Number of published posts for the term.", "type": "integer" }, "description": { "description": "HTML description of the term.", "type": "string" }, "link": { "description": "URL of the term.", "type": "string", "format": "uri" }, "name": { "description": "HTML title for the term.", "type": "string" }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" }, "taxonomy": { "description": "Type attribution for the term.", "type": "string", "enum": [ "country" ] }, "parent": { "description": "The parent term ID.", "type": "integer" }, "meta": { "description": "Meta fields.", "type": "object", "properties": {} }, "acf": { "description": "ACF field data", "type": "object", "properties": {} } }, "required": [ "name" ] }, "City": { "type": "object", "properties": { "id": { "description": "Unique identifier for the term.", "type": "integer" }, "count": { "description": "Number of published posts for the term.", "type": "integer" }, "description": { "description": "HTML description of the term.", "type": "string" }, "link": { "description": "URL of the term.", "type": "string", "format": "uri" }, "name": { "description": "HTML title for the term.", "type": "string" }, "slug": { "description": "An alphanumeric identifier for the term unique to its type.", "type": "string" }, "taxonomy": { "description": "Type attribution for the term.", "type": "string", "enum": [ "city" ] }, "parent": { "description": "The parent term ID.", "type": "integer" }, "meta": { "description": "Meta fields.", "type": "object", "properties": {} }, "acf": { "description": "ACF field data", "type": "object", "properties": {} } }, "required": [ "name" ] }, "Type": { "type": "object", "properties": { "capabilities": { "description": "All capabilities used by the post type.", "type": "object" }, "description": { "description": "A human-readable description of the post type.", "type": "string" }, "hierarchical": { "description": "Whether or not the post type should have children.", "type": "boolean" }, "viewable": { "description": "Whether or not the post type can be viewed.", "type": "boolean" }, "labels": { "description": "Human-readable labels for the post type for various contexts.", "type": "object" }, "name": { "description": "The title for the post type.", "type": "string" }, "slug": { "description": "An alphanumeric identifier for the post type.", "type": "string" }, "supports": { "description": "All features, supported by the post type.", "type": "object" }, "has_archive": { "description": "If the value is a string, the value will be used as the archive slug. If the value is false the post type has no archive.", "type": [ "string", "boolean" ] }, "taxonomies": { "description": "Taxonomies associated with post type.", "type": "array", "items": { "type": "string" } }, "rest_base": { "description": "REST base route for the post type.", "type": "string" }, "rest_namespace": { "description": "REST route's namespace for the post type.", "type": "string" }, "visibility": { "description": "The visibility settings for the post type.", "type": "object", "properties": { "show_ui": { "description": "Whether to generate a default UI for managing this post type.", "type": "boolean" }, "show_in_nav_menus": { "description": "Whether to make the post type available for selection in navigation menus.", "type": "boolean" } } }, "icon": { "description": "The icon for the post type.", "type": [ "string", "null" ] } } }, "Taxonomy": { "type": "object", "properties": { "capabilities": { "description": "All capabilities used by the taxonomy.", "type": "object" }, "description": { "description": "A human-readable description of the taxonomy.", "type": "string" }, "hierarchical": { "description": "Whether or not the taxonomy should have children.", "type": "boolean" }, "labels": { "description": "Human-readable labels for the taxonomy for various contexts.", "type": "object" }, "name": { "description": "The title for the taxonomy.", "type": "string" }, "slug": { "description": "An alphanumeric identifier for the taxonomy.", "type": "string" }, "show_cloud": { "description": "Whether or not the term cloud should be displayed.", "type": "boolean" }, "types": { "description": "Types associated with the taxonomy.", "type": "array", "items": { "type": "string" } }, "rest_base": { "description": "REST base route for the taxonomy.", "type": "string" }, "rest_namespace": { "description": "REST namespace route for the taxonomy.", "type": "string" }, "visibility": { "description": "The visibility settings for the taxonomy.", "type": "object", "properties": { "public": { "description": "Whether a taxonomy is intended for use publicly either via the admin interface or by front-end users.", "type": "boolean" }, "publicly_queryable": { "description": "Whether the taxonomy is publicly queryable.", "type": "boolean" }, "show_ui": { "description": "Whether to generate a default UI for managing this taxonomy.", "type": "boolean" }, "show_admin_column": { "description": "Whether to allow automatic creation of taxonomy columns on associated post-types table.", "type": "boolean" }, "show_in_nav_menus": { "description": "Whether to make the taxonomy available for selection in navigation menus.", "type": "boolean" }, "show_in_quick_edit": { "description": "Whether to show the taxonomy in the quick/bulk edit panel.", "type": "boolean" } } } } }, "Status": { "type": "object", "properties": { "name": { "description": "The title for the status.", "type": "string" }, "private": { "description": "Whether posts with this status should be private.", "type": "boolean" }, "protected": { "description": "Whether posts with this status should be protected.", "type": "boolean" }, "public": { "description": "Whether posts of this status should be shown in the front end of the site.", "type": "boolean" }, "queryable": { "description": "Whether posts with this status should be publicly-queryable.", "type": "boolean" }, "show_in_list": { "description": "Whether to include posts in the edit listing for their post type.", "type": "boolean" }, "slug": { "description": "An alphanumeric identifier for the status.", "type": "string" }, "date_floating": { "description": "Whether posts of this status may have floating published dates.", "type": "boolean" } } }, "SearchResult": { "type": "object", "properties": { "id": { "description": "Unique identifier for the object.", "type": [ "integer", "string" ] }, "title": { "description": "The title for the object.", "type": "string" }, "url": { "description": "URL to the object.", "type": "string", "format": "uri" }, "type": { "description": "Object type.", "type": "string", "enum": [ "post", "term", "post-format" ] }, "subtype": { "description": "Object subtype.", "type": "string", "enum": [ "post", "page", "our_partners", "awards", "products_list", "careers_list", "epkb_post_type_1", "category", "post_tag", "partners_category", "awards_year", "product_category", "country", "city", "office", "epkb_post_type_1_category", "epkb_post_type_1_tag" ] } } }, "User": { "type": "object", "properties": { "id": { "description": "Unique identifier for the user.", "type": "integer" }, "username": { "description": "Login name for the user.", "type": "string" }, "name": { "description": "Display name for the user.", "type": "string" }, "first_name": { "description": "First name for the user.", "type": "string" }, "last_name": { "description": "Last name for the user.", "type": "string" }, "email": { "description": "The email address for the user.", "type": "string", "format": "email" }, "url": { "description": "URL of the user.", "type": "string", "format": "uri" }, "description": { "description": "Description of the user.", "type": "string" }, "link": { "description": "Author URL of the user.", "type": "string", "format": "uri" }, "locale": { "description": "Locale for the user.", "type": "string", "enum": [ "", "en_US", "zh_CN", "zh_HK", "zh_TW" ] }, "nickname": { "description": "The nickname for the user.", "type": "string" }, "slug": { "description": "An alphanumeric identifier for the user.", "type": "string" }, "registered_date": { "description": "Registration date for the user.", "type": "string", "format": "date-time" }, "roles": { "description": "Roles assigned to the user.", "type": "array", "items": { "type": "string" } }, "password": { "description": "Password for the user (never included).", "type": "string" }, "capabilities": { "description": "All capabilities assigned to the user.", "type": "object" }, "extra_capabilities": { "description": "Any extra capabilities assigned to the user.", "type": "object" }, "avatar_urls": { "description": "Avatar URLs for the user.", "type": "object", "properties": { "24": { "description": "Avatar URL with image size of 24 pixels.", "type": "string", "format": "uri" }, "48": { "description": "Avatar URL with image size of 48 pixels.", "type": "string", "format": "uri" }, "96": { "description": "Avatar URL with image size of 96 pixels.", "type": "string", "format": "uri" } } }, "meta": { "description": "Meta fields.", "type": "object", "properties": { "persisted_preferences": { "type": "object", "description": "", "properties": { "_modified": { "description": "The date and time the preferences were updated.", "type": "string", "format": "date-time" } }, "additionalProperties": true } } }, "acf": { "description": "ACF field data", "type": "object", "properties": {} } }, "required": [ "email", "password", "username" ] }, "ApiIndex": { "type": "object", "description": "WordPress REST API root discovery document.", "properties": { "name": { "type": "string", "description": "Site title." }, "description": { "type": "string", "description": "Site tagline." }, "url": { "type": "string", "format": "uri" }, "home": { "type": "string", "format": "uri" }, "gmt_offset": { "type": [ "string", "number" ] }, "timezone_string": { "type": "string" }, "namespaces": { "type": "array", "items": { "type": "string" } }, "authentication": { "type": "object", "description": "Supported authentication mechanisms and their endpoints." }, "routes": { "type": "object", "description": "Every registered route, keyed by path, with methods, endpoints and argument schemas." }, "site_icon_url": { "type": "string", "format": "uri" } } }, "Error": { "type": "object", "description": "WordPress REST error envelope. Not RFC 9457 problem+json — a bespoke JSON object served as application/json.", "properties": { "code": { "type": "string", "description": "Machine-readable error code, e.g. rest_post_invalid_id." }, "message": { "type": "string", "description": "Human-readable message." }, "data": { "type": "object", "properties": { "status": { "type": "integer", "description": "HTTP status code, repeated in the body." }, "params": { "type": "object", "description": "Per-parameter validation messages, when the failure was a bad query parameter." } } } }, "required": [ "code", "message", "data" ] } }, "responses": { "BadRequest": { "description": "Invalid parameter. Body is the WordPress REST error envelope with code rest_invalid_param.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "NotFound": { "description": "No resource with that identifier. Body is the WordPress REST error envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }