{ "openapi": "3.1.0", "info": { "title": "Basker Partner API", "version": "1.0.0", "description": "RESTful API for managing event data and content in the Basker platform. Rate limits are enforced per API key: reads at 100 requests/minute and writes at 20 requests/minute by default; individual tenants may have higher or lower limits configured." }, "servers": [ { "url": "https://api.basker.app/partners", "description": "Current environment" } ], "paths": { "/{version}/{tenant}/pages": { "get": { "tags": [ "Pages" ], "summary": "List Pages", "description": "Retrieve a paginated list of Pages. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Number of items to return" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number" }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "description": "Sort field (prefix with - for descending)" }, { "name": "where", "in": "query", "schema": { "type": "object" }, "description": "Query filters" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/pages" } }, "totalDocs": { "type": "integer" }, "limit": { "type": "integer" }, "totalPages": { "type": "integer" }, "page": { "type": "integer" }, "pagingCounter": { "type": "integer" }, "hasPrevPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "prevPage": { "type": "integer", "nullable": true }, "nextPage": { "type": "integer", "nullable": true } } } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Pages" ], "summary": "Create Page", "description": "Create a new Page. Rate limit: 20 requests per minute per API key. The fields `blocks`, `theme`, and `themeSettings` cannot be set through this endpoint; use the dedicated `{id}/blocks` endpoint.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pages" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pages" } } } }, "422": { "description": "A guarded field (`blocks`, `theme`, or `themeSettings`) was included in the body. Use the dedicated `{id}/blocks` or `{id}/theme-settings` endpoint instead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/pages/{id}": { "get": { "tags": [ "Pages" ], "summary": "Get Page", "description": "Retrieve a single Page by ID. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Page ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pages" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "patch": { "tags": [ "Pages" ], "summary": "Update Page", "description": "Update a Page. Rate limit: 20 requests per minute per API key. The fields `blocks`, `theme`, and `themeSettings` cannot be set through this endpoint; use the dedicated `{id}/blocks` endpoint.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Page ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pages" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pages" } } } }, "404": { "description": "Not found" }, "422": { "description": "A guarded field (`blocks`, `theme`, or `themeSettings`) was included in the body. Use the dedicated `{id}/blocks` or `{id}/theme-settings` endpoint instead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "tags": [ "Pages" ], "summary": "Delete Page", "description": "Delete a Page. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Page ID" } ], "responses": { "204": { "description": "Deleted" }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/pages/theme-settings": { "patch": { "tags": [ "Pages" ], "summary": "Bulk update theme settings", "description": "Bulk set or unset configured theme settings. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "draft", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "When false or omitted, updates the latest published version and syncs only the targeted configured fields into the latest draft when one exists. When true, writes through Payload's draft API so live content is unchanged; if no newer draft exists, Payload creates a draft version from the current published document." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationRequest" } } } }, "responses": { "200": { "description": "Bulk mutation summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationResponse" } } } }, "400": { "description": "Invalid bulk mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "422": { "description": "Bulk mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/pages/{id}/blocks": { "patch": { "tags": [ "Pages" ], "summary": "Mutate document blocks", "description": "Apply ordered block operations (update, insertBefore, insertAfter, append, prepend, remove, moveBefore, moveAfter, replaceAll) to a Page document. Requires `draft: true` and `ifUpdatedAt` in the request body. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Page ID" }, { "name": "locale", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Locale to mutate. Operates strictly on this locale with no fallback, so other locales are untouched." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationRequest" } } } }, "responses": { "200": { "description": "Block mutation result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationResponse" } } } }, "400": { "description": "Invalid block mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "404": { "description": "Document not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "409": { "description": "Conflict: document has been updated since ifUpdatedAt timestamp", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "422": { "description": "Block mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/pages/{id}/theme-settings": { "patch": { "tags": [ "Pages" ], "summary": "Update record theme settings", "description": "Set or unset the theme settings of a single Page document, validated against that document's template (the collection default when none is selected). Requires `draft: true` and `ifUpdatedAt` in the request body. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Page ID" }, { "name": "locale", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Locale to mutate. Operates strictly on this locale with no fallback, so other locales are untouched." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeSettingsMutationRequest" } } } }, "responses": { "200": { "description": "Record theme settings updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeSettingsMutationResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Document not found, or collection unsupported", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict: document has been updated since ifUpdatedAt timestamp", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unknown theme setting for this document's template", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/pages/blocks/schema": { "get": { "tags": [ "Pages" ], "summary": "Get content blocks schema", "description": "Describe the available content blocks for Pages — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "content blocks schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/pages/theme-settings/schema": { "get": { "tags": [ "Pages" ], "summary": "Get theme settings schema", "description": "Describe the available theme settings for Pages — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "theme settings schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/events": { "get": { "tags": [ "Events" ], "summary": "List Events", "description": "Retrieve a paginated list of Events. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Number of items to return" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number" }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "description": "Sort field (prefix with - for descending)" }, { "name": "where", "in": "query", "schema": { "type": "object" }, "description": "Query filters" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/events" } }, "totalDocs": { "type": "integer" }, "limit": { "type": "integer" }, "totalPages": { "type": "integer" }, "page": { "type": "integer" }, "pagingCounter": { "type": "integer" }, "hasPrevPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "prevPage": { "type": "integer", "nullable": true }, "nextPage": { "type": "integer", "nullable": true } } } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Events" ], "summary": "Create Event", "description": "Create a new Event. Rate limit: 20 requests per minute per API key. The fields `blocks`, `theme`, and `themeSettings` cannot be set through this endpoint; use the dedicated `{id}/blocks` endpoint.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/events" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/events" } } } }, "422": { "description": "A guarded field (`blocks`, `theme`, or `themeSettings`) was included in the body. Use the dedicated `{id}/blocks` or `{id}/theme-settings` endpoint instead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/events/{id}": { "get": { "tags": [ "Events" ], "summary": "Get Event", "description": "Retrieve a single Event by ID. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Event ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/events" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "patch": { "tags": [ "Events" ], "summary": "Update Event", "description": "Update a Event. Rate limit: 20 requests per minute per API key. The fields `blocks`, `theme`, and `themeSettings` cannot be set through this endpoint; use the dedicated `{id}/blocks` endpoint.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Event ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/events" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/events" } } } }, "404": { "description": "Not found" }, "422": { "description": "A guarded field (`blocks`, `theme`, or `themeSettings`) was included in the body. Use the dedicated `{id}/blocks` or `{id}/theme-settings` endpoint instead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "tags": [ "Events" ], "summary": "Delete Event", "description": "Delete a Event. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Event ID" } ], "responses": { "204": { "description": "Deleted" }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/events/custom-attributes": { "patch": { "tags": [ "Events" ], "summary": "Bulk update custom attributes", "description": "Bulk set or unset configured custom attributes. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "draft", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "When false or omitted, updates the latest published version and syncs only the targeted configured fields into the latest draft when one exists. When true, writes through Payload's draft API so live content is unchanged; if no newer draft exists, Payload creates a draft version from the current published document." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationRequest" } } } }, "responses": { "200": { "description": "Bulk mutation summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationResponse" } } } }, "400": { "description": "Invalid bulk mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "422": { "description": "Bulk mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/events/theme-settings": { "patch": { "tags": [ "Events" ], "summary": "Bulk update theme settings", "description": "Bulk set or unset configured theme settings. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "draft", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "When false or omitted, updates the latest published version and syncs only the targeted configured fields into the latest draft when one exists. When true, writes through Payload's draft API so live content is unchanged; if no newer draft exists, Payload creates a draft version from the current published document." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationRequest" } } } }, "responses": { "200": { "description": "Bulk mutation summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationResponse" } } } }, "400": { "description": "Invalid bulk mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "422": { "description": "Bulk mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/events/{id}/blocks": { "patch": { "tags": [ "Events" ], "summary": "Mutate document blocks", "description": "Apply ordered block operations (update, insertBefore, insertAfter, append, prepend, remove, moveBefore, moveAfter, replaceAll) to a Event document. Requires `draft: true` and `ifUpdatedAt` in the request body. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Event ID" }, { "name": "locale", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Locale to mutate. Operates strictly on this locale with no fallback, so other locales are untouched." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationRequest" } } } }, "responses": { "200": { "description": "Block mutation result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationResponse" } } } }, "400": { "description": "Invalid block mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "404": { "description": "Document not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "409": { "description": "Conflict: document has been updated since ifUpdatedAt timestamp", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "422": { "description": "Block mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/events/{id}/theme-settings": { "patch": { "tags": [ "Events" ], "summary": "Update record theme settings", "description": "Set or unset the theme settings of a single Event document, validated against that document's template (the collection default when none is selected). Requires `draft: true` and `ifUpdatedAt` in the request body. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Event ID" }, { "name": "locale", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Locale to mutate. Operates strictly on this locale with no fallback, so other locales are untouched." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeSettingsMutationRequest" } } } }, "responses": { "200": { "description": "Record theme settings updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeSettingsMutationResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Document not found, or collection unsupported", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict: document has been updated since ifUpdatedAt timestamp", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unknown theme setting for this document's template", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/events/blocks/schema": { "get": { "tags": [ "Events" ], "summary": "Get content blocks schema", "description": "Describe the available content blocks for Events — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "content blocks schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/events/theme-settings/schema": { "get": { "tags": [ "Events" ], "summary": "Get theme settings schema", "description": "Describe the available theme settings for Events — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "theme settings schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/events/custom-attributes/schema": { "get": { "tags": [ "Events" ], "summary": "Get custom attributes schema", "description": "Describe the available custom attributes for Events — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "custom attributes schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/media": { "get": { "tags": [ "Media" ], "summary": "List Media", "description": "Retrieve a paginated list of Media. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Number of items to return" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number" }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "description": "Sort field (prefix with - for descending)" }, { "name": "where", "in": "query", "schema": { "type": "object" }, "description": "Query filters" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/media" } }, "totalDocs": { "type": "integer" }, "limit": { "type": "integer" }, "totalPages": { "type": "integer" }, "page": { "type": "integer" }, "pagingCounter": { "type": "integer" }, "hasPrevPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "prevPage": { "type": "integer", "nullable": true }, "nextPage": { "type": "integer", "nullable": true } } } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Media" ], "summary": "Create Media", "description": "Create a new Media. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/media" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/media" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/media/{id}": { "get": { "tags": [ "Media" ], "summary": "Get Media", "description": "Retrieve a single Media by ID. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Media ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/media" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "patch": { "tags": [ "Media" ], "summary": "Update Media", "description": "Update a Media. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Media ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/media" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/media" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "tags": [ "Media" ], "summary": "Delete Media", "description": "Delete a Media. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Media ID" } ], "responses": { "204": { "description": "Deleted" }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/files": { "get": { "tags": [ "Files" ], "summary": "List Files", "description": "Retrieve a paginated list of Files. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Number of items to return" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number" }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "description": "Sort field (prefix with - for descending)" }, { "name": "where", "in": "query", "schema": { "type": "object" }, "description": "Query filters" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/files" } }, "totalDocs": { "type": "integer" }, "limit": { "type": "integer" }, "totalPages": { "type": "integer" }, "page": { "type": "integer" }, "pagingCounter": { "type": "integer" }, "hasPrevPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "prevPage": { "type": "integer", "nullable": true }, "nextPage": { "type": "integer", "nullable": true } } } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Files" ], "summary": "Create File", "description": "Create a new File. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/files" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/files" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/files/{id}": { "get": { "tags": [ "Files" ], "summary": "Get File", "description": "Retrieve a single File by ID. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "File ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/files" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "patch": { "tags": [ "Files" ], "summary": "Update File", "description": "Update a File. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "File ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/files" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/files" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "tags": [ "Files" ], "summary": "Delete File", "description": "Delete a File. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "File ID" } ], "responses": { "204": { "description": "Deleted" }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/event-instances": { "get": { "tags": [ "Event Instances" ], "summary": "List Event Instances", "description": "Retrieve a paginated list of Event Instances. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Number of items to return" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number" }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "description": "Sort field (prefix with - for descending)" }, { "name": "where", "in": "query", "schema": { "type": "object" }, "description": "Query filters" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/event-instances" } }, "totalDocs": { "type": "integer" }, "limit": { "type": "integer" }, "totalPages": { "type": "integer" }, "page": { "type": "integer" }, "pagingCounter": { "type": "integer" }, "hasPrevPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "prevPage": { "type": "integer", "nullable": true }, "nextPage": { "type": "integer", "nullable": true } } } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Event Instances" ], "summary": "Create Event Instance", "description": "Create a new Event Instance. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event-instances" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event-instances" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/event-instances/{id}": { "get": { "tags": [ "Event Instances" ], "summary": "Get Event Instance", "description": "Retrieve a single Event Instance by ID. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Event Instance ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event-instances" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "patch": { "tags": [ "Event Instances" ], "summary": "Update Event Instance", "description": "Update a Event Instance. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Event Instance ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event-instances" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event-instances" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "tags": [ "Event Instances" ], "summary": "Delete Event Instance", "description": "Delete a Event Instance. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Event Instance ID" } ], "responses": { "204": { "description": "Deleted" }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/event-instances/custom-attributes": { "patch": { "tags": [ "Event Instances" ], "summary": "Bulk update custom attributes", "description": "Bulk set or unset configured custom attributes. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "draft", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "When false or omitted, updates the latest published version and syncs only the targeted configured fields into the latest draft when one exists. When true, writes through Payload's draft API so live content is unchanged; if no newer draft exists, Payload creates a draft version from the current published document." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationRequest" } } } }, "responses": { "200": { "description": "Bulk mutation summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationResponse" } } } }, "400": { "description": "Invalid bulk mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "422": { "description": "Bulk mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/event-instances/theme-settings": { "patch": { "tags": [ "Event Instances" ], "summary": "Bulk update theme settings", "description": "Bulk set or unset configured theme settings. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "draft", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "When false or omitted, updates the latest published version and syncs only the targeted configured fields into the latest draft when one exists. When true, writes through Payload's draft API so live content is unchanged; if no newer draft exists, Payload creates a draft version from the current published document." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationRequest" } } } }, "responses": { "200": { "description": "Bulk mutation summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationResponse" } } } }, "400": { "description": "Invalid bulk mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "422": { "description": "Bulk mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/event-instances/theme-settings/schema": { "get": { "tags": [ "Event Instances" ], "summary": "Get theme settings schema", "description": "Describe the available theme settings for Event Instances — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "theme settings schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/event-instances/custom-attributes/schema": { "get": { "tags": [ "Event Instances" ], "summary": "Get custom attributes schema", "description": "Describe the available custom attributes for Event Instances — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "custom attributes schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/people": { "get": { "tags": [ "People" ], "summary": "List People", "description": "Retrieve a paginated list of People. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Number of items to return" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number" }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "description": "Sort field (prefix with - for descending)" }, { "name": "where", "in": "query", "schema": { "type": "object" }, "description": "Query filters" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/people" } }, "totalDocs": { "type": "integer" }, "limit": { "type": "integer" }, "totalPages": { "type": "integer" }, "page": { "type": "integer" }, "pagingCounter": { "type": "integer" }, "hasPrevPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "prevPage": { "type": "integer", "nullable": true }, "nextPage": { "type": "integer", "nullable": true } } } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "People" ], "summary": "Create Person", "description": "Create a new Person. Rate limit: 20 requests per minute per API key. The fields `blocks`, `theme`, and `themeSettings` cannot be set through this endpoint; use the dedicated `{id}/blocks` endpoint.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/people" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/people" } } } }, "422": { "description": "A guarded field (`blocks`, `theme`, or `themeSettings`) was included in the body. Use the dedicated `{id}/blocks` or `{id}/theme-settings` endpoint instead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/people/{id}": { "get": { "tags": [ "People" ], "summary": "Get Person", "description": "Retrieve a single Person by ID. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Person ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/people" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "patch": { "tags": [ "People" ], "summary": "Update Person", "description": "Update a Person. Rate limit: 20 requests per minute per API key. The fields `blocks`, `theme`, and `themeSettings` cannot be set through this endpoint; use the dedicated `{id}/blocks` endpoint.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Person ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/people" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/people" } } } }, "404": { "description": "Not found" }, "422": { "description": "A guarded field (`blocks`, `theme`, or `themeSettings`) was included in the body. Use the dedicated `{id}/blocks` or `{id}/theme-settings` endpoint instead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "tags": [ "People" ], "summary": "Delete Person", "description": "Delete a Person. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Person ID" } ], "responses": { "204": { "description": "Deleted" }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/people/custom-attributes": { "patch": { "tags": [ "People" ], "summary": "Bulk update custom attributes", "description": "Bulk set or unset configured custom attributes. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "draft", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "When false or omitted, updates the latest published version and syncs only the targeted configured fields into the latest draft when one exists. When true, writes through Payload's draft API so live content is unchanged; if no newer draft exists, Payload creates a draft version from the current published document." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationRequest" } } } }, "responses": { "200": { "description": "Bulk mutation summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationResponse" } } } }, "400": { "description": "Invalid bulk mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "422": { "description": "Bulk mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/people/theme-settings": { "patch": { "tags": [ "People" ], "summary": "Bulk update theme settings", "description": "Bulk set or unset configured theme settings. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "draft", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "When false or omitted, updates the latest published version and syncs only the targeted configured fields into the latest draft when one exists. When true, writes through Payload's draft API so live content is unchanged; if no newer draft exists, Payload creates a draft version from the current published document." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationRequest" } } } }, "responses": { "200": { "description": "Bulk mutation summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationResponse" } } } }, "400": { "description": "Invalid bulk mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "422": { "description": "Bulk mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/people/{id}/blocks": { "patch": { "tags": [ "People" ], "summary": "Mutate document blocks", "description": "Apply ordered block operations (update, insertBefore, insertAfter, append, prepend, remove, moveBefore, moveAfter, replaceAll) to a Person document. Requires `draft: true` and `ifUpdatedAt` in the request body. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Person ID" }, { "name": "locale", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Locale to mutate. Operates strictly on this locale with no fallback, so other locales are untouched." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationRequest" } } } }, "responses": { "200": { "description": "Block mutation result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationResponse" } } } }, "400": { "description": "Invalid block mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "404": { "description": "Document not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "409": { "description": "Conflict: document has been updated since ifUpdatedAt timestamp", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "422": { "description": "Block mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/people/{id}/theme-settings": { "patch": { "tags": [ "People" ], "summary": "Update record theme settings", "description": "Set or unset the theme settings of a single Person document, validated against that document's template (the collection default when none is selected). Requires `draft: true` and `ifUpdatedAt` in the request body. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Person ID" }, { "name": "locale", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Locale to mutate. Operates strictly on this locale with no fallback, so other locales are untouched." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeSettingsMutationRequest" } } } }, "responses": { "200": { "description": "Record theme settings updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeSettingsMutationResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Document not found, or collection unsupported", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict: document has been updated since ifUpdatedAt timestamp", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unknown theme setting for this document's template", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/people/blocks/schema": { "get": { "tags": [ "People" ], "summary": "Get content blocks schema", "description": "Describe the available content blocks for People — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "content blocks schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/people/theme-settings/schema": { "get": { "tags": [ "People" ], "summary": "Get theme settings schema", "description": "Describe the available theme settings for People — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "theme settings schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/people/custom-attributes/schema": { "get": { "tags": [ "People" ], "summary": "Get custom attributes schema", "description": "Describe the available custom attributes for People — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "custom attributes schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/seasons": { "get": { "tags": [ "Seasons" ], "summary": "List Seasons", "description": "Retrieve a paginated list of Seasons. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Number of items to return" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number" }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "description": "Sort field (prefix with - for descending)" }, { "name": "where", "in": "query", "schema": { "type": "object" }, "description": "Query filters" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/seasons" } }, "totalDocs": { "type": "integer" }, "limit": { "type": "integer" }, "totalPages": { "type": "integer" }, "page": { "type": "integer" }, "pagingCounter": { "type": "integer" }, "hasPrevPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "prevPage": { "type": "integer", "nullable": true }, "nextPage": { "type": "integer", "nullable": true } } } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Seasons" ], "summary": "Create Season", "description": "Create a new Season. Rate limit: 20 requests per minute per API key. The fields `blocks`, `theme`, and `themeSettings` cannot be set through this endpoint; use the dedicated `{id}/blocks` endpoint.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/seasons" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/seasons" } } } }, "422": { "description": "A guarded field (`blocks`, `theme`, or `themeSettings`) was included in the body. Use the dedicated `{id}/blocks` or `{id}/theme-settings` endpoint instead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/seasons/{id}": { "get": { "tags": [ "Seasons" ], "summary": "Get Season", "description": "Retrieve a single Season by ID. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Season ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/seasons" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "patch": { "tags": [ "Seasons" ], "summary": "Update Season", "description": "Update a Season. Rate limit: 20 requests per minute per API key. The fields `blocks`, `theme`, and `themeSettings` cannot be set through this endpoint; use the dedicated `{id}/blocks` endpoint.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Season ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/seasons" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/seasons" } } } }, "404": { "description": "Not found" }, "422": { "description": "A guarded field (`blocks`, `theme`, or `themeSettings`) was included in the body. Use the dedicated `{id}/blocks` or `{id}/theme-settings` endpoint instead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "tags": [ "Seasons" ], "summary": "Delete Season", "description": "Delete a Season. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Season ID" } ], "responses": { "204": { "description": "Deleted" }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/seasons/custom-attributes": { "patch": { "tags": [ "Seasons" ], "summary": "Bulk update custom attributes", "description": "Bulk set or unset configured custom attributes. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "draft", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "When false or omitted, updates the latest published version and syncs only the targeted configured fields into the latest draft when one exists. When true, writes through Payload's draft API so live content is unchanged; if no newer draft exists, Payload creates a draft version from the current published document." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationRequest" } } } }, "responses": { "200": { "description": "Bulk mutation summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationResponse" } } } }, "400": { "description": "Invalid bulk mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "422": { "description": "Bulk mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/seasons/theme-settings": { "patch": { "tags": [ "Seasons" ], "summary": "Bulk update theme settings", "description": "Bulk set or unset configured theme settings. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "draft", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "When false or omitted, updates the latest published version and syncs only the targeted configured fields into the latest draft when one exists. When true, writes through Payload's draft API so live content is unchanged; if no newer draft exists, Payload creates a draft version from the current published document." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationRequest" } } } }, "responses": { "200": { "description": "Bulk mutation summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationResponse" } } } }, "400": { "description": "Invalid bulk mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "422": { "description": "Bulk mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/seasons/{id}/blocks": { "patch": { "tags": [ "Seasons" ], "summary": "Mutate document blocks", "description": "Apply ordered block operations (update, insertBefore, insertAfter, append, prepend, remove, moveBefore, moveAfter, replaceAll) to a Season document. Requires `draft: true` and `ifUpdatedAt` in the request body. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Season ID" }, { "name": "locale", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Locale to mutate. Operates strictly on this locale with no fallback, so other locales are untouched." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationRequest" } } } }, "responses": { "200": { "description": "Block mutation result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationResponse" } } } }, "400": { "description": "Invalid block mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "404": { "description": "Document not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "409": { "description": "Conflict: document has been updated since ifUpdatedAt timestamp", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "422": { "description": "Block mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/seasons/{id}/theme-settings": { "patch": { "tags": [ "Seasons" ], "summary": "Update record theme settings", "description": "Set or unset the theme settings of a single Season document, validated against that document's template (the collection default when none is selected). Requires `draft: true` and `ifUpdatedAt` in the request body. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Season ID" }, { "name": "locale", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Locale to mutate. Operates strictly on this locale with no fallback, so other locales are untouched." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeSettingsMutationRequest" } } } }, "responses": { "200": { "description": "Record theme settings updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeSettingsMutationResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Document not found, or collection unsupported", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict: document has been updated since ifUpdatedAt timestamp", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unknown theme setting for this document's template", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/seasons/blocks/schema": { "get": { "tags": [ "Seasons" ], "summary": "Get content blocks schema", "description": "Describe the available content blocks for Seasons — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "content blocks schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/seasons/theme-settings/schema": { "get": { "tags": [ "Seasons" ], "summary": "Get theme settings schema", "description": "Describe the available theme settings for Seasons — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "theme settings schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/seasons/custom-attributes/schema": { "get": { "tags": [ "Seasons" ], "summary": "Get custom attributes schema", "description": "Describe the available custom attributes for Seasons — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "custom attributes schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/series": { "get": { "tags": [ "Series" ], "summary": "List Series", "description": "Retrieve a paginated list of Series. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Number of items to return" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number" }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "description": "Sort field (prefix with - for descending)" }, { "name": "where", "in": "query", "schema": { "type": "object" }, "description": "Query filters" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/series" } }, "totalDocs": { "type": "integer" }, "limit": { "type": "integer" }, "totalPages": { "type": "integer" }, "page": { "type": "integer" }, "pagingCounter": { "type": "integer" }, "hasPrevPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "prevPage": { "type": "integer", "nullable": true }, "nextPage": { "type": "integer", "nullable": true } } } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Series" ], "summary": "Create Series", "description": "Create a new Series. Rate limit: 20 requests per minute per API key. The fields `blocks`, `theme`, and `themeSettings` cannot be set through this endpoint; use the dedicated `{id}/blocks` endpoint.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/series" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/series" } } } }, "422": { "description": "A guarded field (`blocks`, `theme`, or `themeSettings`) was included in the body. Use the dedicated `{id}/blocks` or `{id}/theme-settings` endpoint instead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/series/{id}": { "get": { "tags": [ "Series" ], "summary": "Get Series", "description": "Retrieve a single Series by ID. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Series ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/series" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "patch": { "tags": [ "Series" ], "summary": "Update Series", "description": "Update a Series. Rate limit: 20 requests per minute per API key. The fields `blocks`, `theme`, and `themeSettings` cannot be set through this endpoint; use the dedicated `{id}/blocks` endpoint.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Series ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/series" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/series" } } } }, "404": { "description": "Not found" }, "422": { "description": "A guarded field (`blocks`, `theme`, or `themeSettings`) was included in the body. Use the dedicated `{id}/blocks` or `{id}/theme-settings` endpoint instead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "tags": [ "Series" ], "summary": "Delete Series", "description": "Delete a Series. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Series ID" } ], "responses": { "204": { "description": "Deleted" }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/series/custom-attributes": { "patch": { "tags": [ "Series" ], "summary": "Bulk update custom attributes", "description": "Bulk set or unset configured custom attributes. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "draft", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "When false or omitted, updates the latest published version and syncs only the targeted configured fields into the latest draft when one exists. When true, writes through Payload's draft API so live content is unchanged; if no newer draft exists, Payload creates a draft version from the current published document." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationRequest" } } } }, "responses": { "200": { "description": "Bulk mutation summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationResponse" } } } }, "400": { "description": "Invalid bulk mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "422": { "description": "Bulk mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/series/theme-settings": { "patch": { "tags": [ "Series" ], "summary": "Bulk update theme settings", "description": "Bulk set or unset configured theme settings. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "draft", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "When false or omitted, updates the latest published version and syncs only the targeted configured fields into the latest draft when one exists. When true, writes through Payload's draft API so live content is unchanged; if no newer draft exists, Payload creates a draft version from the current published document." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationRequest" } } } }, "responses": { "200": { "description": "Bulk mutation summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationResponse" } } } }, "400": { "description": "Invalid bulk mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "422": { "description": "Bulk mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/series/{id}/blocks": { "patch": { "tags": [ "Series" ], "summary": "Mutate document blocks", "description": "Apply ordered block operations (update, insertBefore, insertAfter, append, prepend, remove, moveBefore, moveAfter, replaceAll) to a Series document. Requires `draft: true` and `ifUpdatedAt` in the request body. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Series ID" }, { "name": "locale", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Locale to mutate. Operates strictly on this locale with no fallback, so other locales are untouched." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationRequest" } } } }, "responses": { "200": { "description": "Block mutation result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationResponse" } } } }, "400": { "description": "Invalid block mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "404": { "description": "Document not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "409": { "description": "Conflict: document has been updated since ifUpdatedAt timestamp", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "422": { "description": "Block mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/series/{id}/theme-settings": { "patch": { "tags": [ "Series" ], "summary": "Update record theme settings", "description": "Set or unset the theme settings of a single Series document, validated against that document's template (the collection default when none is selected). Requires `draft: true` and `ifUpdatedAt` in the request body. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Series ID" }, { "name": "locale", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Locale to mutate. Operates strictly on this locale with no fallback, so other locales are untouched." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeSettingsMutationRequest" } } } }, "responses": { "200": { "description": "Record theme settings updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeSettingsMutationResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Document not found, or collection unsupported", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict: document has been updated since ifUpdatedAt timestamp", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unknown theme setting for this document's template", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/series/blocks/schema": { "get": { "tags": [ "Series" ], "summary": "Get content blocks schema", "description": "Describe the available content blocks for Series — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "content blocks schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/series/theme-settings/schema": { "get": { "tags": [ "Series" ], "summary": "Get theme settings schema", "description": "Describe the available theme settings for Series — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "theme settings schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/series/custom-attributes/schema": { "get": { "tags": [ "Series" ], "summary": "Get custom attributes schema", "description": "Describe the available custom attributes for Series — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "custom attributes schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/works": { "get": { "tags": [ "Works" ], "summary": "List Works", "description": "Retrieve a paginated list of Works. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Number of items to return" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number" }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "description": "Sort field (prefix with - for descending)" }, { "name": "where", "in": "query", "schema": { "type": "object" }, "description": "Query filters" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/works" } }, "totalDocs": { "type": "integer" }, "limit": { "type": "integer" }, "totalPages": { "type": "integer" }, "page": { "type": "integer" }, "pagingCounter": { "type": "integer" }, "hasPrevPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "prevPage": { "type": "integer", "nullable": true }, "nextPage": { "type": "integer", "nullable": true } } } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Works" ], "summary": "Create Work", "description": "Create a new Work. Rate limit: 20 requests per minute per API key. The fields `blocks`, `theme`, and `themeSettings` cannot be set through this endpoint; use the dedicated `{id}/blocks` endpoint.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/works" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/works" } } } }, "422": { "description": "A guarded field (`blocks`, `theme`, or `themeSettings`) was included in the body. Use the dedicated `{id}/blocks` or `{id}/theme-settings` endpoint instead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/works/{id}": { "get": { "tags": [ "Works" ], "summary": "Get Work", "description": "Retrieve a single Work by ID. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Work ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/works" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "patch": { "tags": [ "Works" ], "summary": "Update Work", "description": "Update a Work. Rate limit: 20 requests per minute per API key. The fields `blocks`, `theme`, and `themeSettings` cannot be set through this endpoint; use the dedicated `{id}/blocks` endpoint.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Work ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/works" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/works" } } } }, "404": { "description": "Not found" }, "422": { "description": "A guarded field (`blocks`, `theme`, or `themeSettings`) was included in the body. Use the dedicated `{id}/blocks` or `{id}/theme-settings` endpoint instead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "tags": [ "Works" ], "summary": "Delete Work", "description": "Delete a Work. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Work ID" } ], "responses": { "204": { "description": "Deleted" }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/works/custom-attributes": { "patch": { "tags": [ "Works" ], "summary": "Bulk update custom attributes", "description": "Bulk set or unset configured custom attributes. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "draft", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "When false or omitted, updates the latest published version and syncs only the targeted configured fields into the latest draft when one exists. When true, writes through Payload's draft API so live content is unchanged; if no newer draft exists, Payload creates a draft version from the current published document." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationRequest" } } } }, "responses": { "200": { "description": "Bulk mutation summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationResponse" } } } }, "400": { "description": "Invalid bulk mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "422": { "description": "Bulk mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/works/theme-settings": { "patch": { "tags": [ "Works" ], "summary": "Bulk update theme settings", "description": "Bulk set or unset configured theme settings. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "draft", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "When false or omitted, updates the latest published version and syncs only the targeted configured fields into the latest draft when one exists. When true, writes through Payload's draft API so live content is unchanged; if no newer draft exists, Payload creates a draft version from the current published document." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationRequest" } } } }, "responses": { "200": { "description": "Bulk mutation summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationResponse" } } } }, "400": { "description": "Invalid bulk mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "422": { "description": "Bulk mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/works/{id}/blocks": { "patch": { "tags": [ "Works" ], "summary": "Mutate document blocks", "description": "Apply ordered block operations (update, insertBefore, insertAfter, append, prepend, remove, moveBefore, moveAfter, replaceAll) to a Work document. Requires `draft: true` and `ifUpdatedAt` in the request body. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Work ID" }, { "name": "locale", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Locale to mutate. Operates strictly on this locale with no fallback, so other locales are untouched." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationRequest" } } } }, "responses": { "200": { "description": "Block mutation result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationResponse" } } } }, "400": { "description": "Invalid block mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "404": { "description": "Document not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "409": { "description": "Conflict: document has been updated since ifUpdatedAt timestamp", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "422": { "description": "Block mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/works/{id}/theme-settings": { "patch": { "tags": [ "Works" ], "summary": "Update record theme settings", "description": "Set or unset the theme settings of a single Work document, validated against that document's template (the collection default when none is selected). Requires `draft: true` and `ifUpdatedAt` in the request body. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Work ID" }, { "name": "locale", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Locale to mutate. Operates strictly on this locale with no fallback, so other locales are untouched." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeSettingsMutationRequest" } } } }, "responses": { "200": { "description": "Record theme settings updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeSettingsMutationResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Document not found, or collection unsupported", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict: document has been updated since ifUpdatedAt timestamp", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unknown theme setting for this document's template", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/works/blocks/schema": { "get": { "tags": [ "Works" ], "summary": "Get content blocks schema", "description": "Describe the available content blocks for Works — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "content blocks schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/works/theme-settings/schema": { "get": { "tags": [ "Works" ], "summary": "Get theme settings schema", "description": "Describe the available theme settings for Works — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "theme settings schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/works/custom-attributes/schema": { "get": { "tags": [ "Works" ], "summary": "Get custom attributes schema", "description": "Describe the available custom attributes for Works — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "custom attributes schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/venues": { "get": { "tags": [ "Venues" ], "summary": "List Venues", "description": "Retrieve a paginated list of Venues. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Number of items to return" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number" }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "description": "Sort field (prefix with - for descending)" }, { "name": "where", "in": "query", "schema": { "type": "object" }, "description": "Query filters" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/venues" } }, "totalDocs": { "type": "integer" }, "limit": { "type": "integer" }, "totalPages": { "type": "integer" }, "page": { "type": "integer" }, "pagingCounter": { "type": "integer" }, "hasPrevPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "prevPage": { "type": "integer", "nullable": true }, "nextPage": { "type": "integer", "nullable": true } } } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Venues" ], "summary": "Create Venue", "description": "Create a new Venue. Rate limit: 20 requests per minute per API key. The fields `blocks`, `theme`, and `themeSettings` cannot be set through this endpoint; use the dedicated `{id}/blocks` endpoint.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/venues" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/venues" } } } }, "422": { "description": "A guarded field (`blocks`, `theme`, or `themeSettings`) was included in the body. Use the dedicated `{id}/blocks` or `{id}/theme-settings` endpoint instead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/venues/{id}": { "get": { "tags": [ "Venues" ], "summary": "Get Venue", "description": "Retrieve a single Venue by ID. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Venue ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/venues" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "patch": { "tags": [ "Venues" ], "summary": "Update Venue", "description": "Update a Venue. Rate limit: 20 requests per minute per API key. The fields `blocks`, `theme`, and `themeSettings` cannot be set through this endpoint; use the dedicated `{id}/blocks` endpoint.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Venue ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/venues" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/venues" } } } }, "404": { "description": "Not found" }, "422": { "description": "A guarded field (`blocks`, `theme`, or `themeSettings`) was included in the body. Use the dedicated `{id}/blocks` or `{id}/theme-settings` endpoint instead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "tags": [ "Venues" ], "summary": "Delete Venue", "description": "Delete a Venue. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Venue ID" } ], "responses": { "204": { "description": "Deleted" }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/venues/custom-attributes": { "patch": { "tags": [ "Venues" ], "summary": "Bulk update custom attributes", "description": "Bulk set or unset configured custom attributes. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "draft", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "When false or omitted, updates the latest published version and syncs only the targeted configured fields into the latest draft when one exists. When true, writes through Payload's draft API so live content is unchanged; if no newer draft exists, Payload creates a draft version from the current published document." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationRequest" } } } }, "responses": { "200": { "description": "Bulk mutation summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationResponse" } } } }, "400": { "description": "Invalid bulk mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "422": { "description": "Bulk mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/venues/theme-settings": { "patch": { "tags": [ "Venues" ], "summary": "Bulk update theme settings", "description": "Bulk set or unset configured theme settings. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "draft", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "When false or omitted, updates the latest published version and syncs only the targeted configured fields into the latest draft when one exists. When true, writes through Payload's draft API so live content is unchanged; if no newer draft exists, Payload creates a draft version from the current published document." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationRequest" } } } }, "responses": { "200": { "description": "Bulk mutation summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationResponse" } } } }, "400": { "description": "Invalid bulk mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "422": { "description": "Bulk mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/venues/{id}/blocks": { "patch": { "tags": [ "Venues" ], "summary": "Mutate document blocks", "description": "Apply ordered block operations (update, insertBefore, insertAfter, append, prepend, remove, moveBefore, moveAfter, replaceAll) to a Venue document. Requires `draft: true` and `ifUpdatedAt` in the request body. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Venue ID" }, { "name": "locale", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Locale to mutate. Operates strictly on this locale with no fallback, so other locales are untouched." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationRequest" } } } }, "responses": { "200": { "description": "Block mutation result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationResponse" } } } }, "400": { "description": "Invalid block mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "404": { "description": "Document not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "409": { "description": "Conflict: document has been updated since ifUpdatedAt timestamp", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "422": { "description": "Block mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/venues/{id}/theme-settings": { "patch": { "tags": [ "Venues" ], "summary": "Update record theme settings", "description": "Set or unset the theme settings of a single Venue document, validated against that document's template (the collection default when none is selected). Requires `draft: true` and `ifUpdatedAt` in the request body. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Venue ID" }, { "name": "locale", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Locale to mutate. Operates strictly on this locale with no fallback, so other locales are untouched." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeSettingsMutationRequest" } } } }, "responses": { "200": { "description": "Record theme settings updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeSettingsMutationResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Document not found, or collection unsupported", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict: document has been updated since ifUpdatedAt timestamp", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unknown theme setting for this document's template", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/venues/blocks/schema": { "get": { "tags": [ "Venues" ], "summary": "Get content blocks schema", "description": "Describe the available content blocks for Venues — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "content blocks schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/venues/theme-settings/schema": { "get": { "tags": [ "Venues" ], "summary": "Get theme settings schema", "description": "Describe the available theme settings for Venues — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "theme settings schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/venues/custom-attributes/schema": { "get": { "tags": [ "Venues" ], "summary": "Get custom attributes schema", "description": "Describe the available custom attributes for Venues — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "custom attributes schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/organizations": { "get": { "tags": [ "Organizations" ], "summary": "List Organizations", "description": "Retrieve a paginated list of Organizations. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Number of items to return" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number" }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "description": "Sort field (prefix with - for descending)" }, { "name": "where", "in": "query", "schema": { "type": "object" }, "description": "Query filters" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/organizations" } }, "totalDocs": { "type": "integer" }, "limit": { "type": "integer" }, "totalPages": { "type": "integer" }, "page": { "type": "integer" }, "pagingCounter": { "type": "integer" }, "hasPrevPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "prevPage": { "type": "integer", "nullable": true }, "nextPage": { "type": "integer", "nullable": true } } } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Organizations" ], "summary": "Create Organization", "description": "Create a new Organization. Rate limit: 20 requests per minute per API key. The fields `blocks`, `theme`, and `themeSettings` cannot be set through this endpoint; use the dedicated `{id}/blocks` endpoint.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organizations" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organizations" } } } }, "422": { "description": "A guarded field (`blocks`, `theme`, or `themeSettings`) was included in the body. Use the dedicated `{id}/blocks` or `{id}/theme-settings` endpoint instead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/organizations/{id}": { "get": { "tags": [ "Organizations" ], "summary": "Get Organization", "description": "Retrieve a single Organization by ID. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Organization ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organizations" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "patch": { "tags": [ "Organizations" ], "summary": "Update Organization", "description": "Update a Organization. Rate limit: 20 requests per minute per API key. The fields `blocks`, `theme`, and `themeSettings` cannot be set through this endpoint; use the dedicated `{id}/blocks` endpoint.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Organization ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organizations" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organizations" } } } }, "404": { "description": "Not found" }, "422": { "description": "A guarded field (`blocks`, `theme`, or `themeSettings`) was included in the body. Use the dedicated `{id}/blocks` or `{id}/theme-settings` endpoint instead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "tags": [ "Organizations" ], "summary": "Delete Organization", "description": "Delete a Organization. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Organization ID" } ], "responses": { "204": { "description": "Deleted" }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/organizations/custom-attributes": { "patch": { "tags": [ "Organizations" ], "summary": "Bulk update custom attributes", "description": "Bulk set or unset configured custom attributes. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "draft", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "When false or omitted, updates the latest published version and syncs only the targeted configured fields into the latest draft when one exists. When true, writes through Payload's draft API so live content is unchanged; if no newer draft exists, Payload creates a draft version from the current published document." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationRequest" } } } }, "responses": { "200": { "description": "Bulk mutation summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationResponse" } } } }, "400": { "description": "Invalid bulk mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "422": { "description": "Bulk mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/organizations/theme-settings": { "patch": { "tags": [ "Organizations" ], "summary": "Bulk update theme settings", "description": "Bulk set or unset configured theme settings. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "draft", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "When false or omitted, updates the latest published version and syncs only the targeted configured fields into the latest draft when one exists. When true, writes through Payload's draft API so live content is unchanged; if no newer draft exists, Payload creates a draft version from the current published document." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationRequest" } } } }, "responses": { "200": { "description": "Bulk mutation summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationResponse" } } } }, "400": { "description": "Invalid bulk mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "422": { "description": "Bulk mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/organizations/{id}/blocks": { "patch": { "tags": [ "Organizations" ], "summary": "Mutate document blocks", "description": "Apply ordered block operations (update, insertBefore, insertAfter, append, prepend, remove, moveBefore, moveAfter, replaceAll) to a Organization document. Requires `draft: true` and `ifUpdatedAt` in the request body. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Organization ID" }, { "name": "locale", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Locale to mutate. Operates strictly on this locale with no fallback, so other locales are untouched." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationRequest" } } } }, "responses": { "200": { "description": "Block mutation result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationResponse" } } } }, "400": { "description": "Invalid block mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "404": { "description": "Document not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "409": { "description": "Conflict: document has been updated since ifUpdatedAt timestamp", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "422": { "description": "Block mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/organizations/{id}/theme-settings": { "patch": { "tags": [ "Organizations" ], "summary": "Update record theme settings", "description": "Set or unset the theme settings of a single Organization document, validated against that document's template (the collection default when none is selected). Requires `draft: true` and `ifUpdatedAt` in the request body. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Organization ID" }, { "name": "locale", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Locale to mutate. Operates strictly on this locale with no fallback, so other locales are untouched." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeSettingsMutationRequest" } } } }, "responses": { "200": { "description": "Record theme settings updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeSettingsMutationResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Document not found, or collection unsupported", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict: document has been updated since ifUpdatedAt timestamp", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unknown theme setting for this document's template", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/organizations/blocks/schema": { "get": { "tags": [ "Organizations" ], "summary": "Get content blocks schema", "description": "Describe the available content blocks for Organizations — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "content blocks schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/organizations/theme-settings/schema": { "get": { "tags": [ "Organizations" ], "summary": "Get theme settings schema", "description": "Describe the available theme settings for Organizations — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "theme settings schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/organizations/custom-attributes/schema": { "get": { "tags": [ "Organizations" ], "summary": "Get custom attributes schema", "description": "Describe the available custom attributes for Organizations — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "custom attributes schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/blogs": { "get": { "tags": [ "Blogs" ], "summary": "List Blogs", "description": "Retrieve a paginated list of Blogs. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Number of items to return" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number" }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "description": "Sort field (prefix with - for descending)" }, { "name": "where", "in": "query", "schema": { "type": "object" }, "description": "Query filters" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/blogs" } }, "totalDocs": { "type": "integer" }, "limit": { "type": "integer" }, "totalPages": { "type": "integer" }, "page": { "type": "integer" }, "pagingCounter": { "type": "integer" }, "hasPrevPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "prevPage": { "type": "integer", "nullable": true }, "nextPage": { "type": "integer", "nullable": true } } } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Blogs" ], "summary": "Create Blog", "description": "Create a new Blog. Rate limit: 20 requests per minute per API key. The fields `blocks`, `theme`, and `themeSettings` cannot be set through this endpoint; use the dedicated `{id}/blocks` endpoint.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/blogs" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/blogs" } } } }, "422": { "description": "A guarded field (`blocks`, `theme`, or `themeSettings`) was included in the body. Use the dedicated `{id}/blocks` or `{id}/theme-settings` endpoint instead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/blogs/{id}": { "get": { "tags": [ "Blogs" ], "summary": "Get Blog", "description": "Retrieve a single Blog by ID. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Blog ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/blogs" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "patch": { "tags": [ "Blogs" ], "summary": "Update Blog", "description": "Update a Blog. Rate limit: 20 requests per minute per API key. The fields `blocks`, `theme`, and `themeSettings` cannot be set through this endpoint; use the dedicated `{id}/blocks` endpoint.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Blog ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/blogs" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/blogs" } } } }, "404": { "description": "Not found" }, "422": { "description": "A guarded field (`blocks`, `theme`, or `themeSettings`) was included in the body. Use the dedicated `{id}/blocks` or `{id}/theme-settings` endpoint instead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "tags": [ "Blogs" ], "summary": "Delete Blog", "description": "Delete a Blog. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Blog ID" } ], "responses": { "204": { "description": "Deleted" }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/blogs/theme-settings": { "patch": { "tags": [ "Blogs" ], "summary": "Bulk update theme settings", "description": "Bulk set or unset configured theme settings. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "draft", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "When false or omitted, updates the latest published version and syncs only the targeted configured fields into the latest draft when one exists. When true, writes through Payload's draft API so live content is unchanged; if no newer draft exists, Payload creates a draft version from the current published document." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationRequest" } } } }, "responses": { "200": { "description": "Bulk mutation summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationResponse" } } } }, "400": { "description": "Invalid bulk mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "422": { "description": "Bulk mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/blogs/{id}/blocks": { "patch": { "tags": [ "Blogs" ], "summary": "Mutate document blocks", "description": "Apply ordered block operations (update, insertBefore, insertAfter, append, prepend, remove, moveBefore, moveAfter, replaceAll) to a Blog document. Requires `draft: true` and `ifUpdatedAt` in the request body. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Blog ID" }, { "name": "locale", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Locale to mutate. Operates strictly on this locale with no fallback, so other locales are untouched." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationRequest" } } } }, "responses": { "200": { "description": "Block mutation result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationResponse" } } } }, "400": { "description": "Invalid block mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "404": { "description": "Document not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "409": { "description": "Conflict: document has been updated since ifUpdatedAt timestamp", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "422": { "description": "Block mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/blogs/{id}/theme-settings": { "patch": { "tags": [ "Blogs" ], "summary": "Update record theme settings", "description": "Set or unset the theme settings of a single Blog document, validated against that document's template (the collection default when none is selected). Requires `draft: true` and `ifUpdatedAt` in the request body. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Blog ID" }, { "name": "locale", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Locale to mutate. Operates strictly on this locale with no fallback, so other locales are untouched." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeSettingsMutationRequest" } } } }, "responses": { "200": { "description": "Record theme settings updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeSettingsMutationResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Document not found, or collection unsupported", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict: document has been updated since ifUpdatedAt timestamp", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unknown theme setting for this document's template", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/blogs/blocks/schema": { "get": { "tags": [ "Blogs" ], "summary": "Get content blocks schema", "description": "Describe the available content blocks for Blogs — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "content blocks schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/blogs/theme-settings/schema": { "get": { "tags": [ "Blogs" ], "summary": "Get theme settings schema", "description": "Describe the available theme settings for Blogs — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "theme settings schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/posts": { "get": { "tags": [ "Posts" ], "summary": "List Posts", "description": "Retrieve a paginated list of Posts. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Number of items to return" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number" }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "description": "Sort field (prefix with - for descending)" }, { "name": "where", "in": "query", "schema": { "type": "object" }, "description": "Query filters" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/posts" } }, "totalDocs": { "type": "integer" }, "limit": { "type": "integer" }, "totalPages": { "type": "integer" }, "page": { "type": "integer" }, "pagingCounter": { "type": "integer" }, "hasPrevPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "prevPage": { "type": "integer", "nullable": true }, "nextPage": { "type": "integer", "nullable": true } } } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Posts" ], "summary": "Create Post", "description": "Create a new Post. Rate limit: 20 requests per minute per API key. The fields `blocks`, `theme`, and `themeSettings` cannot be set through this endpoint; use the dedicated `{id}/blocks` endpoint.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/posts" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/posts" } } } }, "422": { "description": "A guarded field (`blocks`, `theme`, or `themeSettings`) was included in the body. Use the dedicated `{id}/blocks` or `{id}/theme-settings` endpoint instead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/posts/{id}": { "get": { "tags": [ "Posts" ], "summary": "Get Post", "description": "Retrieve a single Post by ID. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Post ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/posts" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "patch": { "tags": [ "Posts" ], "summary": "Update Post", "description": "Update a Post. Rate limit: 20 requests per minute per API key. The fields `blocks`, `theme`, and `themeSettings` cannot be set through this endpoint; use the dedicated `{id}/blocks` endpoint.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Post ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/posts" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/posts" } } } }, "404": { "description": "Not found" }, "422": { "description": "A guarded field (`blocks`, `theme`, or `themeSettings`) was included in the body. Use the dedicated `{id}/blocks` or `{id}/theme-settings` endpoint instead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "tags": [ "Posts" ], "summary": "Delete Post", "description": "Delete a Post. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Post ID" } ], "responses": { "204": { "description": "Deleted" }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/posts/custom-attributes": { "patch": { "tags": [ "Posts" ], "summary": "Bulk update custom attributes", "description": "Bulk set or unset configured custom attributes. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "draft", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "When false or omitted, updates the latest published version and syncs only the targeted configured fields into the latest draft when one exists. When true, writes through Payload's draft API so live content is unchanged; if no newer draft exists, Payload creates a draft version from the current published document." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationRequest" } } } }, "responses": { "200": { "description": "Bulk mutation summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationResponse" } } } }, "400": { "description": "Invalid bulk mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "422": { "description": "Bulk mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/posts/theme-settings": { "patch": { "tags": [ "Posts" ], "summary": "Bulk update theme settings", "description": "Bulk set or unset configured theme settings. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "draft", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "When false or omitted, updates the latest published version and syncs only the targeted configured fields into the latest draft when one exists. When true, writes through Payload's draft API so live content is unchanged; if no newer draft exists, Payload creates a draft version from the current published document." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationRequest" } } } }, "responses": { "200": { "description": "Bulk mutation summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationResponse" } } } }, "400": { "description": "Invalid bulk mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "422": { "description": "Bulk mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/posts/{id}/blocks": { "patch": { "tags": [ "Posts" ], "summary": "Mutate document blocks", "description": "Apply ordered block operations (update, insertBefore, insertAfter, append, prepend, remove, moveBefore, moveAfter, replaceAll) to a Post document. Requires `draft: true` and `ifUpdatedAt` in the request body. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Post ID" }, { "name": "locale", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Locale to mutate. Operates strictly on this locale with no fallback, so other locales are untouched." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationRequest" } } } }, "responses": { "200": { "description": "Block mutation result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationResponse" } } } }, "400": { "description": "Invalid block mutation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "404": { "description": "Document not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "409": { "description": "Conflict: document has been updated since ifUpdatedAt timestamp", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "422": { "description": "Block mutation validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockMutationError" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/posts/{id}/theme-settings": { "patch": { "tags": [ "Posts" ], "summary": "Update record theme settings", "description": "Set or unset the theme settings of a single Post document, validated against that document's template (the collection default when none is selected). Requires `draft: true` and `ifUpdatedAt` in the request body. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Post ID" }, { "name": "locale", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Locale to mutate. Operates strictly on this locale with no fallback, so other locales are untouched." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeSettingsMutationRequest" } } } }, "responses": { "200": { "description": "Record theme settings updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeSettingsMutationResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Document not found, or collection unsupported", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict: document has been updated since ifUpdatedAt timestamp", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unknown theme setting for this document's template", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/posts/blocks/schema": { "get": { "tags": [ "Posts" ], "summary": "Get content blocks schema", "description": "Describe the available content blocks for Posts — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "content blocks schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/posts/theme-settings/schema": { "get": { "tags": [ "Posts" ], "summary": "Get theme settings schema", "description": "Describe the available theme settings for Posts — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "theme settings schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/posts/custom-attributes/schema": { "get": { "tags": [ "Posts" ], "summary": "Get custom attributes schema", "description": "Describe the available custom attributes for Posts — keys/types/options needed to construct a valid write. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "custom attributes schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldSchemaResponse" } } } }, "404": { "description": "Not supported for this collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/custom-attributes": { "get": { "tags": [ "Custom Attributes" ], "summary": "List Custom Attributes", "description": "Retrieve a paginated list of Custom Attributes. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Number of items to return" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number" }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "description": "Sort field (prefix with - for descending)" }, { "name": "where", "in": "query", "schema": { "type": "object" }, "description": "Query filters" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/custom-attributes" } }, "totalDocs": { "type": "integer" }, "limit": { "type": "integer" }, "totalPages": { "type": "integer" }, "page": { "type": "integer" }, "pagingCounter": { "type": "integer" }, "hasPrevPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "prevPage": { "type": "integer", "nullable": true }, "nextPage": { "type": "integer", "nullable": true } } } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Custom Attributes" ], "summary": "Create Custom Attribute", "description": "Create a new Custom Attribute. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-attributes" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-attributes" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/custom-attributes/{id}": { "get": { "tags": [ "Custom Attributes" ], "summary": "Get Custom Attribute", "description": "Retrieve a single Custom Attribute by ID. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Custom Attribute ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-attributes" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "patch": { "tags": [ "Custom Attributes" ], "summary": "Update Custom Attribute", "description": "Update a Custom Attribute. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Custom Attribute ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-attributes" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-attributes" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "tags": [ "Custom Attributes" ], "summary": "Delete Custom Attribute", "description": "Delete a Custom Attribute. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Custom Attribute ID" } ], "responses": { "204": { "description": "Deleted" }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/custom-object-definitions": { "get": { "tags": [ "Custom Object Definitions" ], "summary": "List Custom Object Definitions", "description": "Retrieve a paginated list of Custom Object Definitions. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Number of items to return" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number" }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "description": "Sort field (prefix with - for descending)" }, { "name": "where", "in": "query", "schema": { "type": "object" }, "description": "Query filters" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/custom-objects" } }, "totalDocs": { "type": "integer" }, "limit": { "type": "integer" }, "totalPages": { "type": "integer" }, "page": { "type": "integer" }, "pagingCounter": { "type": "integer" }, "hasPrevPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "prevPage": { "type": "integer", "nullable": true }, "nextPage": { "type": "integer", "nullable": true } } } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Custom Object Definitions" ], "summary": "Create Custom Object", "description": "Create a new Custom Object. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-objects" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-objects" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/custom-object-definitions/{id}": { "get": { "tags": [ "Custom Object Definitions" ], "summary": "Get Custom Object", "description": "Retrieve a single Custom Object by ID. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Custom Object ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-objects" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "patch": { "tags": [ "Custom Object Definitions" ], "summary": "Update Custom Object", "description": "Update a Custom Object. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Custom Object ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-objects" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-objects" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "tags": [ "Custom Object Definitions" ], "summary": "Delete Custom Object", "description": "Delete a Custom Object. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Custom Object ID" } ], "responses": { "204": { "description": "Deleted" }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/custom-object-instances": { "get": { "tags": [ "Custom Object Instances" ], "summary": "List Custom Object Instances", "description": "Retrieve a paginated list of Custom Object Instances. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Number of items to return" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number" }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "description": "Sort field (prefix with - for descending)" }, { "name": "where", "in": "query", "schema": { "type": "object" }, "description": "Query filters" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/custom-object-instances" } }, "totalDocs": { "type": "integer" }, "limit": { "type": "integer" }, "totalPages": { "type": "integer" }, "page": { "type": "integer" }, "pagingCounter": { "type": "integer" }, "hasPrevPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "prevPage": { "type": "integer", "nullable": true }, "nextPage": { "type": "integer", "nullable": true } } } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Custom Object Instances" ], "summary": "Create Custom Object Instance", "description": "Create a new Custom Object Instance. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-object-instances" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-object-instances" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/custom-object-instances/{id}": { "get": { "tags": [ "Custom Object Instances" ], "summary": "Get Custom Object Instance", "description": "Retrieve a single Custom Object Instance by ID. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Custom Object Instance ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-object-instances" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "patch": { "tags": [ "Custom Object Instances" ], "summary": "Update Custom Object Instance", "description": "Update a Custom Object Instance. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Custom Object Instance ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-object-instances" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-object-instances" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "tags": [ "Custom Object Instances" ], "summary": "Delete Custom Object Instance", "description": "Delete a Custom Object Instance. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Custom Object Instance ID" } ], "responses": { "204": { "description": "Deleted" }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/redirects": { "get": { "tags": [ "Redirects" ], "summary": "List Redirects", "description": "Retrieve a paginated list of Redirects. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Number of items to return" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number" }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "description": "Sort field (prefix with - for descending)" }, { "name": "where", "in": "query", "schema": { "type": "object" }, "description": "Query filters" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/redirects" } }, "totalDocs": { "type": "integer" }, "limit": { "type": "integer" }, "totalPages": { "type": "integer" }, "page": { "type": "integer" }, "pagingCounter": { "type": "integer" }, "hasPrevPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "prevPage": { "type": "integer", "nullable": true }, "nextPage": { "type": "integer", "nullable": true } } } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Redirects" ], "summary": "Create Redirect", "description": "Create a new Redirect. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/redirects" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/redirects" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/redirects/{id}": { "get": { "tags": [ "Redirects" ], "summary": "Get Redirect", "description": "Retrieve a single Redirect by ID. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Redirect ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/redirects" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "patch": { "tags": [ "Redirects" ], "summary": "Update Redirect", "description": "Update a Redirect. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Redirect ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/redirects" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/redirects" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "tags": [ "Redirects" ], "summary": "Delete Redirect", "description": "Delete a Redirect. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Redirect ID" } ], "responses": { "204": { "description": "Deleted" }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/forms": { "get": { "tags": [ "Forms" ], "summary": "List Forms", "description": "Retrieve a paginated list of Forms. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Number of items to return" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number" }, { "name": "sort", "in": "query", "schema": { "type": "string" }, "description": "Sort field (prefix with - for descending)" }, { "name": "where", "in": "query", "schema": { "type": "object" }, "description": "Query filters" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/forms" } }, "totalDocs": { "type": "integer" }, "limit": { "type": "integer" }, "totalPages": { "type": "integer" }, "page": { "type": "integer" }, "pagingCounter": { "type": "integer" }, "hasPrevPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "prevPage": { "type": "integer", "nullable": true }, "nextPage": { "type": "integer", "nullable": true } } } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Forms" ], "summary": "Create Form", "description": "Create a new Form. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forms" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forms" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/forms/{id}": { "get": { "tags": [ "Forms" ], "summary": "Get Form", "description": "Retrieve a single Form by ID. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Form ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forms" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "patch": { "tags": [ "Forms" ], "summary": "Update Form", "description": "Update a Form. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Form ID" }, { "name": "select", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Field selection object. Example query: select[slug]=true&select[updatedAt]=true", "example": { "slug": true, "updatedAt": true } }, { "name": "populate", "in": "query", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true }, "description": "Relationship population object. Example query: populate[media][url]=true", "example": { "media": { "url": true } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forms" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forms" } } } }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "tags": [ "Forms" ], "summary": "Delete Form", "description": "Delete a Form. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Form ID" } ], "responses": { "204": { "description": "Deleted" }, "404": { "description": "Not found" }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/theme/settings/schema": { "get": { "tags": [ "Theme" ], "summary": "Get theme settings schema", "description": "Describe the tenant theme's global settings — keys/types/options. Rate limit: 100 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "responses": { "200": { "description": "Theme settings schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguredFieldSchemaResponse" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 100 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/{version}/{tenant}/theme/settings": { "patch": { "tags": [ "Theme" ], "summary": "Update theme settings", "description": "Update the tenant's theme-level settings. Requires draft set to true and an ifUpdatedAt timestamp. Rate limit: 20 requests per minute per API key.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "2026-02" ], "default": "2026-02" }, "description": "API version" }, { "name": "tenant", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tenant slug" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeSettingsMutationRequest" } } } }, "responses": { "200": { "description": "Theme settings updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeSettingsMutationResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No theme for tenant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale ifUpdatedAt", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests. This endpoint is limited to 20 requests per minute per API key.", "headers": { "Retry-After": { "description": "Number of seconds to wait before retrying.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } } } }, "security": [ { "apiKey": [] } ] } } }, "components": { "schemas": { "pages": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tenant": { "type": "string", "description": "tenants ID" }, "title": { "type": "string" }, "richTitle": { "type": "string" }, "richTitle_html": { "type": "string" }, "description": { "type": "string" }, "richDescription": { "type": "string" }, "richDescription_html": { "type": "string" }, "theme": { "type": "object", "properties": { "themeSettings": { "type": "array", "items": { "type": "object" } } } }, "meta": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "canonical": { "type": "string" }, "image": { "type": "string", "description": "File ID" } } }, "slug": { "type": "string" }, "publishedSlug": { "type": "string" }, "publishedRelativePath": { "type": "string" }, "createRedirect": { "type": "boolean" }, "relativePath": { "type": "string" }, "displayTitle": { "type": "string" }, "image": { "type": "string", "description": "File ID" }, "parent": { "type": "string", "description": "pages ID" }, "order": { "type": "string" }, "showInNavigation": { "type": "boolean" }, "showInSearch": { "type": "boolean" }, "themeTemplate": { "type": "string" }, "breadcrumbs": { "type": "array", "items": { "type": "object" } }, "publishedAt": { "type": "string", "format": "date-time" }, "url": { "type": "string" }, "sharedWith": { "type": "array", "items": { "type": "string" }, "description": "Array of tenants IDs" }, "_status": { "type": "string", "enum": [ "draft", "published" ] } }, "required": [ "id" ] }, "events": { "type": "object", "properties": { "id": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "title": { "type": "string" }, "externalId": { "type": "string" }, "description": { "type": "string" }, "venue": { "type": "string", "description": "venues ID" }, "duration": { "type": "number" }, "company": { "type": "string", "description": "organizations ID" }, "startDate": { "type": "string", "format": "date-time" }, "startDate_tz": { "type": "string", "enum": [ "Pacific/Midway", "Pacific/Niue", "Pacific/Honolulu", "Pacific/Rarotonga", "America/Anchorage", "Pacific/Gambier", "America/Los_Angeles", "America/Tijuana", "America/Denver", "America/Phoenix", "America/Chicago", "America/Guatemala", "America/New_York", "America/Bogota", "America/Caracas", "America/Santiago", "America/Buenos_Aires", "America/Sao_Paulo", "Atlantic/South_Georgia", "Atlantic/Azores", "Atlantic/Cape_Verde", "Europe/London", "Europe/Berlin", "Europe/Paris", "Africa/Lagos", "Europe/Athens", "Africa/Cairo", "Europe/Moscow", "Asia/Riyadh", "Asia/Dubai", "Asia/Baku", "Asia/Karachi", "Asia/Tashkent", "Asia/Calcutta", "Asia/Dhaka", "Asia/Almaty", "Asia/Jakarta", "Asia/Bangkok", "Asia/Shanghai", "Asia/Singapore", "Asia/Tokyo", "Asia/Seoul", "Australia/Brisbane", "Australia/Sydney", "Pacific/Guam", "Pacific/Noumea", "Pacific/Auckland", "Pacific/Fiji" ] }, "endDate": { "type": "string", "format": "date-time" }, "endDate_tz": { "type": "string", "enum": [ "Pacific/Midway", "Pacific/Niue", "Pacific/Honolulu", "Pacific/Rarotonga", "America/Anchorage", "Pacific/Gambier", "America/Los_Angeles", "America/Tijuana", "America/Denver", "America/Phoenix", "America/Chicago", "America/Guatemala", "America/New_York", "America/Bogota", "America/Caracas", "America/Santiago", "America/Buenos_Aires", "America/Sao_Paulo", "Atlantic/South_Georgia", "Atlantic/Azores", "Atlantic/Cape_Verde", "Europe/London", "Europe/Berlin", "Europe/Paris", "Africa/Lagos", "Europe/Athens", "Africa/Cairo", "Europe/Moscow", "Asia/Riyadh", "Asia/Dubai", "Asia/Baku", "Asia/Karachi", "Asia/Tashkent", "Asia/Calcutta", "Asia/Dhaka", "Asia/Almaty", "Asia/Jakarta", "Asia/Bangkok", "Asia/Shanghai", "Asia/Singapore", "Asia/Tokyo", "Asia/Seoul", "Australia/Brisbane", "Australia/Sydney", "Pacific/Guam", "Pacific/Noumea", "Pacific/Auckland", "Pacific/Fiji" ] }, "startDateLocal": { "type": "string" }, "endDateLocal": { "type": "string" }, "season": { "type": "string", "description": "seasons ID" }, "series": { "type": "array", "items": { "type": "string" }, "description": "Array of series IDs" }, "works": { "type": "array", "items": { "type": "string" }, "description": "Array of works IDs" }, "participants": { "type": "array", "items": { "type": "object" } }, "tessitura": { "type": "object", "properties": { "syncConnected": { "type": "boolean" }, "productionSeasonIds": { "type": "object" }, "performanceSyncType": { "type": "string", "enum": [ "all", "specific" ] }, "productionPerformances": { "type": "object" }, "keywords": { "type": "object" }, "eventFieldMaps": { "type": "object", "properties": { "overrideEventMaps": { "type": "boolean" }, "eventSyncMap": { "type": "object", "properties": { "baskerFields": { "type": "array", "items": { "type": "object" } }, "customAttributes": { "type": "array", "items": { "type": "object" } } } } } }, "eventInstanceFieldMaps": { "type": "object", "properties": { "overrideInstanceMaps": { "type": "boolean" }, "eventInstanceSyncMap": { "type": "object", "properties": { "syncInstances": { "type": "boolean" }, "addNew": { "type": "boolean" }, "visibility": { "type": "object", "properties": { "usePublishApiDates": { "type": "boolean" }, "useAvailSaleIndicator": { "type": "boolean" } } }, "removeInvalid": { "type": "boolean" }, "baskerFields": { "type": "array", "items": { "type": "object" } }, "customAttributes": { "type": "array", "items": { "type": "object" } } } } } }, "modesOfSale": { "type": "object", "properties": { "overrideModesOfSale": { "type": "boolean" }, "customModesOfSale": { "type": "number" } } } } }, "spektrix": { "type": "object", "properties": { "syncConnected": { "type": "boolean" }, "eventId": { "type": "string" }, "eventSyncType": { "type": "string", "enum": [ "all", "specific" ] }, "spektrixInstances": { "type": "object" }, "eventFieldMaps": { "type": "object", "properties": { "overrideEventMaps": { "type": "boolean" }, "eventSyncMap": { "type": "object", "properties": { "baskerFields": { "type": "array", "items": { "type": "object" } }, "customAttributes": { "type": "array", "items": { "type": "object" } } } } } }, "eventInstanceFieldMaps": { "type": "object", "properties": { "overrideInstanceMaps": { "type": "boolean" }, "eventInstanceSyncMap": { "type": "object", "properties": { "syncInstances": { "type": "boolean" }, "addNew": { "type": "boolean" }, "removeInvalid": { "type": "boolean" }, "baskerFields": { "type": "array", "items": { "type": "object" } }, "customAttributes": { "type": "array", "items": { "type": "object" } } } } } } } }, "elevent": { "type": "object", "properties": { "syncConnected": { "type": "boolean" }, "eventId": { "type": "string" }, "eventFieldMaps": { "type": "object", "properties": { "overrideEventMaps": { "type": "boolean" }, "eventSyncMap": { "type": "object", "properties": { "baskerFields": { "type": "array", "items": { "type": "object" } }, "customAttributes": { "type": "array", "items": { "type": "object" } } } } } }, "eventInstanceFieldMaps": { "type": "object", "properties": { "overrideInstanceMaps": { "type": "boolean" }, "eventInstanceSyncMap": { "type": "object", "properties": { "syncInstances": { "type": "boolean" }, "addNew": { "type": "boolean" }, "removeInvalid": { "type": "boolean" }, "baskerFields": { "type": "array", "items": { "type": "object" } }, "customAttributes": { "type": "array", "items": { "type": "object" } } } } } } } }, "image": { "type": "string", "description": "File ID" }, "showInSearch": { "type": "boolean" }, "url": { "type": "string" }, "hideStartTime": { "type": "boolean" }, "slug": { "type": "string" }, "startDateLocalAsUTC": { "type": "string" }, "endDateLocalAsUTC": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object" } } }, "required": [ "id" ] }, "media": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "alt": { "type": "string" }, "caption": { "type": "string" }, "credit": { "type": "string" }, "filename": { "type": "string" }, "focalX": { "type": "number" }, "focalY": { "type": "number" }, "height": { "type": "number" }, "prefix": { "type": "string" }, "src": { "type": "string" }, "url": { "type": "string" }, "width": { "type": "number" } } }, "files": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tenant": { "type": "string", "description": "tenants ID" }, "src": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Array of media-tags IDs" }, "prefix": { "type": "string" }, "folder": { "type": "string", "description": "basker-folders ID" }, "url": { "type": "string" }, "thumbnailURL": { "type": "string" }, "filename": { "type": "string" }, "mimeType": { "type": "string" }, "filesize": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "focalX": { "type": "number" }, "focalY": { "type": "number" } }, "required": [ "id" ] }, "event-instances": { "type": "object", "properties": { "event": { "type": "string", "description": "events ID" }, "startDate": { "type": "string", "format": "date-time" }, "startDate_tz": { "type": "string", "enum": [ "Pacific/Midway", "Pacific/Niue", "Pacific/Honolulu", "Pacific/Rarotonga", "America/Anchorage", "Pacific/Gambier", "America/Los_Angeles", "America/Tijuana", "America/Denver", "America/Phoenix", "America/Chicago", "America/Guatemala", "America/New_York", "America/Bogota", "America/Caracas", "America/Santiago", "America/Buenos_Aires", "America/Sao_Paulo", "Atlantic/South_Georgia", "Atlantic/Azores", "Atlantic/Cape_Verde", "Europe/London", "Europe/Berlin", "Europe/Paris", "Africa/Lagos", "Europe/Athens", "Africa/Cairo", "Europe/Moscow", "Asia/Riyadh", "Asia/Dubai", "Asia/Baku", "Asia/Karachi", "Asia/Tashkent", "Asia/Calcutta", "Asia/Dhaka", "Asia/Almaty", "Asia/Jakarta", "Asia/Bangkok", "Asia/Shanghai", "Asia/Singapore", "Asia/Tokyo", "Asia/Seoul", "Australia/Brisbane", "Australia/Sydney", "Pacific/Guam", "Pacific/Noumea", "Pacific/Auckland", "Pacific/Fiji" ] }, "startDateLocalAsUTC": { "type": "string" }, "ticketingSystemId": { "type": "string" }, "participants": { "type": "array", "items": { "type": "object" } }, "attributes": { "type": "array", "items": { "type": "object" } }, "tessitura": { "type": "object", "properties": { "performanceId": { "type": "string" }, "productionSeasonId": { "type": "string" }, "keywords": { "type": "object" }, "availability": { "type": "string" }, "availSaleIndicator": { "type": "string" }, "publishWebApiStartDate": { "type": "string", "format": "date-time" }, "publishWebApiEndDate": { "type": "string", "format": "date-time" }, "customAttributeSyncOverride": { "type": "object" } } }, "elevent": { "type": "object", "properties": { "showTimeId": { "type": "string" }, "eventId": { "type": "string" }, "eventUrlName": { "type": "string" }, "customAttributeSyncOverride": { "type": "object" } } }, "spektrix": { "type": "object", "properties": { "instanceId": { "type": "string" }, "eventId": { "type": "string" }, "customAttributeSyncOverride": { "type": "object" } } }, "booking": { "type": "object", "properties": { "bookingLinkLabel": { "type": "string" }, "bookingLinkURL": { "type": "string" } } }, "venue": { "type": "string", "description": "venues ID" }, "series": { "type": "array", "items": { "type": "string" }, "description": "Array of series IDs" } } }, "people": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tenant": { "type": "string", "description": "tenants ID" }, "name": { "type": "string" }, "richName": { "type": "string" }, "richName_html": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "pronouns": { "type": "string" }, "role": { "type": "string" }, "layout": { "type": "string", "description": "layouts ID" }, "blocks": { "type": "array", "items": { "type": "object" } }, "theme": { "type": "object", "properties": { "themeSettings": { "type": "array", "items": { "type": "object" } } } }, "attributes": { "type": "array", "items": { "type": "object" } }, "meta": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "canonical": { "type": "string" }, "image": { "type": "string", "description": "File ID" } } }, "slug": { "type": "string" }, "publishedSlug": { "type": "string" }, "publishedRelativePath": { "type": "string" }, "createRedirect": { "type": "boolean" }, "url": { "type": "string" }, "shortId": { "type": "string" }, "baseSlug": { "type": "string" }, "primaryForTitle": { "type": "boolean" }, "image": { "type": "string", "description": "File ID" }, "showInSearch": { "type": "boolean" }, "hasBlocks": { "type": "boolean" }, "sharedWith": { "type": "array", "items": { "type": "string" }, "description": "Array of tenants IDs" }, "_status": { "type": "string", "enum": [ "draft", "published" ] } }, "required": [ "id" ] }, "seasons": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tenant": { "type": "string", "description": "tenants ID" }, "title": { "type": "string" }, "richTitle": { "type": "string" }, "richTitle_html": { "type": "string" }, "description": { "type": "string" }, "richDescription": { "type": "string" }, "richDescription_html": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "startDate_tz": { "type": "string", "enum": [ "Pacific/Midway", "Pacific/Niue", "Pacific/Honolulu", "Pacific/Rarotonga", "America/Anchorage", "Pacific/Gambier", "America/Los_Angeles", "America/Tijuana", "America/Denver", "America/Phoenix", "America/Chicago", "America/Guatemala", "America/New_York", "America/Bogota", "America/Caracas", "America/Santiago", "America/Buenos_Aires", "America/Sao_Paulo", "Atlantic/South_Georgia", "Atlantic/Azores", "Atlantic/Cape_Verde", "Europe/London", "Europe/Berlin", "Europe/Paris", "Africa/Lagos", "Europe/Athens", "Africa/Cairo", "Europe/Moscow", "Asia/Riyadh", "Asia/Dubai", "Asia/Baku", "Asia/Karachi", "Asia/Tashkent", "Asia/Calcutta", "Asia/Dhaka", "Asia/Almaty", "Asia/Jakarta", "Asia/Bangkok", "Asia/Shanghai", "Asia/Singapore", "Asia/Tokyo", "Asia/Seoul", "Australia/Brisbane", "Australia/Sydney", "Pacific/Guam", "Pacific/Noumea", "Pacific/Auckland", "Pacific/Fiji" ] }, "endDate": { "type": "string", "format": "date-time" }, "endDate_tz": { "type": "string", "enum": [ "Pacific/Midway", "Pacific/Niue", "Pacific/Honolulu", "Pacific/Rarotonga", "America/Anchorage", "Pacific/Gambier", "America/Los_Angeles", "America/Tijuana", "America/Denver", "America/Phoenix", "America/Chicago", "America/Guatemala", "America/New_York", "America/Bogota", "America/Caracas", "America/Santiago", "America/Buenos_Aires", "America/Sao_Paulo", "Atlantic/South_Georgia", "Atlantic/Azores", "Atlantic/Cape_Verde", "Europe/London", "Europe/Berlin", "Europe/Paris", "Africa/Lagos", "Europe/Athens", "Africa/Cairo", "Europe/Moscow", "Asia/Riyadh", "Asia/Dubai", "Asia/Baku", "Asia/Karachi", "Asia/Tashkent", "Asia/Calcutta", "Asia/Dhaka", "Asia/Almaty", "Asia/Jakarta", "Asia/Bangkok", "Asia/Shanghai", "Asia/Singapore", "Asia/Tokyo", "Asia/Seoul", "Australia/Brisbane", "Australia/Sydney", "Pacific/Guam", "Pacific/Noumea", "Pacific/Auckland", "Pacific/Fiji" ] }, "events": { "type": "object" }, "layout": { "type": "string", "description": "layouts ID" }, "blocks": { "type": "array", "items": { "type": "object" } }, "theme": { "type": "object", "properties": { "themeSettings": { "type": "array", "items": { "type": "object" } } } }, "attributes": { "type": "array", "items": { "type": "object" } }, "slug": { "type": "string" }, "slugLock": { "type": "boolean" }, "publishedSlug": { "type": "string" }, "publishedRelativePath": { "type": "string" }, "createRedirect": { "type": "boolean" }, "image": { "type": "string", "description": "File ID" }, "url": { "type": "string" }, "shortId": { "type": "string" }, "baseSlug": { "type": "string" }, "primaryForTitle": { "type": "boolean" }, "sharedWith": { "type": "array", "items": { "type": "string" }, "description": "Array of tenants IDs" }, "tessitura": { "type": "object", "properties": { "seasonId": { "type": "string" } } }, "_status": { "type": "string", "enum": [ "draft", "published" ] } }, "required": [ "id" ] }, "series": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tenant": { "type": "string", "description": "tenants ID" }, "title": { "type": "string" }, "richTitle": { "type": "string" }, "richTitle_html": { "type": "string" }, "displayTitle": { "type": "string" }, "description": { "type": "string" }, "richDescription": { "type": "string" }, "richDescription_html": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "startDate_tz": { "type": "string", "enum": [ "Pacific/Midway", "Pacific/Niue", "Pacific/Honolulu", "Pacific/Rarotonga", "America/Anchorage", "Pacific/Gambier", "America/Los_Angeles", "America/Tijuana", "America/Denver", "America/Phoenix", "America/Chicago", "America/Guatemala", "America/New_York", "America/Bogota", "America/Caracas", "America/Santiago", "America/Buenos_Aires", "America/Sao_Paulo", "Atlantic/South_Georgia", "Atlantic/Azores", "Atlantic/Cape_Verde", "Europe/London", "Europe/Berlin", "Europe/Paris", "Africa/Lagos", "Europe/Athens", "Africa/Cairo", "Europe/Moscow", "Asia/Riyadh", "Asia/Dubai", "Asia/Baku", "Asia/Karachi", "Asia/Tashkent", "Asia/Calcutta", "Asia/Dhaka", "Asia/Almaty", "Asia/Jakarta", "Asia/Bangkok", "Asia/Shanghai", "Asia/Singapore", "Asia/Tokyo", "Asia/Seoul", "Australia/Brisbane", "Australia/Sydney", "Pacific/Guam", "Pacific/Noumea", "Pacific/Auckland", "Pacific/Fiji" ] }, "endDate": { "type": "string", "format": "date-time" }, "endDate_tz": { "type": "string", "enum": [ "Pacific/Midway", "Pacific/Niue", "Pacific/Honolulu", "Pacific/Rarotonga", "America/Anchorage", "Pacific/Gambier", "America/Los_Angeles", "America/Tijuana", "America/Denver", "America/Phoenix", "America/Chicago", "America/Guatemala", "America/New_York", "America/Bogota", "America/Caracas", "America/Santiago", "America/Buenos_Aires", "America/Sao_Paulo", "Atlantic/South_Georgia", "Atlantic/Azores", "Atlantic/Cape_Verde", "Europe/London", "Europe/Berlin", "Europe/Paris", "Africa/Lagos", "Europe/Athens", "Africa/Cairo", "Europe/Moscow", "Asia/Riyadh", "Asia/Dubai", "Asia/Baku", "Asia/Karachi", "Asia/Tashkent", "Asia/Calcutta", "Asia/Dhaka", "Asia/Almaty", "Asia/Jakarta", "Asia/Bangkok", "Asia/Shanghai", "Asia/Singapore", "Asia/Tokyo", "Asia/Seoul", "Australia/Brisbane", "Australia/Sydney", "Pacific/Guam", "Pacific/Noumea", "Pacific/Auckland", "Pacific/Fiji" ] }, "events": { "type": "object" }, "event-instances": { "type": "object" }, "layout": { "type": "string", "description": "layouts ID" }, "blocks": { "type": "array", "items": { "type": "object" } }, "theme": { "type": "object", "properties": { "themeSettings": { "type": "array", "items": { "type": "object" } } } }, "attributes": { "type": "array", "items": { "type": "object" } }, "meta": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "canonical": { "type": "string" }, "image": { "type": "string", "description": "File ID" } } }, "slug": { "type": "string" }, "publishedSlug": { "type": "string" }, "publishedRelativePath": { "type": "string" }, "createRedirect": { "type": "boolean" }, "url": { "type": "string" }, "shortId": { "type": "string" }, "baseSlug": { "type": "string" }, "primaryForTitle": { "type": "boolean" }, "image": { "type": "string", "description": "File ID" }, "sharedWith": { "type": "array", "items": { "type": "string" }, "description": "Array of tenants IDs" }, "tessitura": { "type": "object", "properties": { "packageId": { "type": "string" } } }, "_status": { "type": "string", "enum": [ "draft", "published" ] } }, "required": [ "id" ] }, "works": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tenant": { "type": "string", "description": "tenants ID" }, "title": { "type": "string" }, "richTitle": { "type": "string" }, "richTitle_html": { "type": "string" }, "description": { "type": "string" }, "richDescription": { "type": "string" }, "richDescription_html": { "type": "string" }, "layout": { "type": "string", "description": "layouts ID" }, "blocks": { "type": "array", "items": { "type": "object" } }, "theme": { "type": "object", "properties": { "themeSettings": { "type": "array", "items": { "type": "object" } } } }, "attributes": { "type": "array", "items": { "type": "object" } }, "slug": { "type": "string" }, "slugLock": { "type": "boolean" }, "publishedSlug": { "type": "string" }, "publishedRelativePath": { "type": "string" }, "createRedirect": { "type": "boolean" }, "creator": { "type": "array", "items": { "type": "string" }, "description": "Array of people,organizations IDs" }, "image": { "type": "string", "description": "File ID" }, "url": { "type": "string" }, "hasBlocks": { "type": "boolean" }, "shortId": { "type": "string" }, "baseSlug": { "type": "string" }, "primaryForTitle": { "type": "boolean" }, "sharedWith": { "type": "array", "items": { "type": "string" }, "description": "Array of tenants IDs" }, "_status": { "type": "string", "enum": [ "draft", "published" ] } }, "required": [ "id" ] }, "venues": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tenant": { "type": "string", "description": "tenants ID" }, "title": { "type": "string" }, "richTitle": { "type": "string" }, "richTitle_html": { "type": "string" }, "description": { "type": "string" }, "richDescription": { "type": "string" }, "richDescription_html": { "type": "string" }, "website": { "type": "string" }, "country": { "type": "string", "enum": [ "US", "GB", "CA", "JP", "AU", "NZ", "DE", "AT", "BE", "IE", "LU", "DK", "GR", "HU", "NO", "SK", "SI", "SE", "FI", "IS", "FR", "IT", "SA", "KR" ] }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "directions": { "type": "string" }, "openingHours": { "type": "object", "properties": { "timezone": { "type": "string", "enum": [ "Pacific/Midway", "Pacific/Niue", "Pacific/Honolulu", "Pacific/Rarotonga", "America/Anchorage", "Pacific/Gambier", "America/Los_Angeles", "America/Tijuana", "America/Denver", "America/Phoenix", "America/Chicago", "America/Guatemala", "America/New_York", "America/Bogota", "America/Caracas", "America/Santiago", "America/Buenos_Aires", "America/Sao_Paulo", "Atlantic/South_Georgia", "Atlantic/Azores", "Atlantic/Cape_Verde", "Europe/London", "Europe/Berlin", "Europe/Paris", "Africa/Lagos", "Europe/Athens", "Africa/Cairo", "Europe/Moscow", "Asia/Riyadh", "Asia/Dubai", "Asia/Baku", "Asia/Karachi", "Asia/Tashkent", "Asia/Calcutta", "Asia/Dhaka", "Asia/Almaty", "Asia/Jakarta", "Asia/Bangkok", "Asia/Shanghai", "Asia/Singapore", "Asia/Tokyo", "Asia/Seoul", "Australia/Brisbane", "Australia/Sydney", "Pacific/Guam", "Pacific/Noumea", "Pacific/Auckland", "Pacific/Fiji" ] }, "sections": { "type": "array", "items": { "type": "object" } }, "exceptions": { "type": "array", "items": { "type": "object" } }, "notes": { "type": "string" } } }, "layout": { "type": "string", "description": "layouts ID" }, "blocks": { "type": "array", "items": { "type": "object" } }, "attributes": { "type": "array", "items": { "type": "object" } }, "slug": { "type": "string" }, "slugLock": { "type": "boolean" }, "publishedSlug": { "type": "string" }, "publishedRelativePath": { "type": "string" }, "createRedirect": { "type": "boolean" }, "image": { "type": "string", "description": "File ID" }, "url": { "type": "string" }, "shortId": { "type": "string" }, "sharedWith": { "type": "array", "items": { "type": "string" }, "description": "Array of tenants IDs" }, "_status": { "type": "string", "enum": [ "draft", "published" ] } }, "required": [ "id" ] }, "organizations": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tenant": { "type": "string", "description": "tenants ID" }, "name": { "type": "string" }, "richName": { "type": "string" }, "richName_html": { "type": "string" }, "description": { "type": "string" }, "richDescription": { "type": "string" }, "richDescription_html": { "type": "string" }, "type": { "type": "string", "enum": [ "producer", "sponsor" ] }, "layout": { "type": "string", "description": "layouts ID" }, "blocks": { "type": "array", "items": { "type": "object" } }, "theme": { "type": "object", "properties": { "themeSettings": { "type": "array", "items": { "type": "object" } } } }, "attributes": { "type": "array", "items": { "type": "object" } }, "slug": { "type": "string" }, "slugLock": { "type": "boolean" }, "publishedSlug": { "type": "string" }, "publishedRelativePath": { "type": "string" }, "createRedirect": { "type": "boolean" }, "image": { "type": "string", "description": "File ID" }, "url": { "type": "string" }, "shortId": { "type": "string" }, "sharedWith": { "type": "array", "items": { "type": "string" }, "description": "Array of tenants IDs" }, "_status": { "type": "string", "enum": [ "draft", "published" ] } }, "required": [ "id" ] }, "blogs": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tenant": { "type": "string", "description": "tenants ID" }, "title": { "type": "string" }, "richTitle": { "type": "string" }, "richTitle_html": { "type": "string" }, "description": { "type": "string" }, "richDescription": { "type": "string" }, "richDescription_html": { "type": "string" }, "layout": { "type": "string", "description": "layouts ID" }, "blocks": { "type": "array", "items": { "type": "object" } }, "posts": { "type": "object" }, "theme": { "type": "object", "properties": { "themeSettings": { "type": "array", "items": { "type": "object" } } } }, "meta": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "canonical": { "type": "string" }, "image": { "type": "string", "description": "File ID" } } }, "slug": { "type": "string" }, "publishedSlug": { "type": "string" }, "publishedRelativePath": { "type": "string" }, "createRedirect": { "type": "boolean" }, "categories": { "type": "object" }, "tags": { "type": "object" }, "image": { "type": "string", "description": "File ID" }, "url": { "type": "string" }, "sharedWith": { "type": "array", "items": { "type": "string" }, "description": "Array of tenants IDs" }, "_status": { "type": "string", "enum": [ "draft", "published" ] } }, "required": [ "id" ] }, "posts": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tenant": { "type": "string", "description": "tenants ID" }, "title": { "type": "string" }, "richTitle": { "type": "string" }, "richTitle_html": { "type": "string" }, "description": { "type": "string" }, "richDescription": { "type": "string" }, "richDescription_html": { "type": "string" }, "layout": { "type": "string", "description": "layouts ID" }, "blocks": { "type": "array", "items": { "type": "object" } }, "attributes": { "type": "array", "items": { "type": "object" } }, "meta": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "canonical": { "type": "string" }, "image": { "type": "string", "description": "File ID" } } }, "slug": { "type": "string" }, "publishedSlug": { "type": "string" }, "publishedRelativePath": { "type": "string" }, "createRedirect": { "type": "boolean" }, "publishDate": { "type": "string", "format": "date-time" }, "blog": { "type": "string", "description": "blogs ID" }, "authors": { "type": "array", "items": { "type": "string" }, "description": "Array of authors IDs" }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Array of categories IDs" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Array of tags IDs" }, "image": { "type": "string", "description": "File ID" }, "url": { "type": "string" }, "showInSearch": { "type": "boolean" }, "sharedWith": { "type": "array", "items": { "type": "string" }, "description": "Array of tenants IDs" }, "_status": { "type": "string", "enum": [ "draft", "published" ] } }, "required": [ "id" ] }, "custom-attributes": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tenant": { "type": "string", "description": "tenants ID" }, "EventsAttributes": { "type": "array", "items": { "type": "object" } }, "EventInstancesAttributes": { "type": "array", "items": { "type": "object" } }, "PostsAttributes": { "type": "array", "items": { "type": "object" } }, "SeasonsAttributes": { "type": "array", "items": { "type": "object" } }, "SeriesAttributes": { "type": "array", "items": { "type": "object" } }, "WorksAttributes": { "type": "array", "items": { "type": "object" } }, "VenuesAttributes": { "type": "array", "items": { "type": "object" } }, "OrganizationsAttributes": { "type": "array", "items": { "type": "object" } }, "PeopleAttributes": { "type": "array", "items": { "type": "object" } } }, "required": [ "id" ] }, "custom-objects": { "type": "object", "properties": { "description": { "type": "string" }, "fieldDefinitions": { "type": "array", "items": { "type": "object" } }, "handle": { "type": "string" }, "icon": { "type": "string" }, "label": { "type": "string" } } }, "custom-object-instances": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "type": "object" } }, "definition": { "type": "string", "description": "custom-objects ID" }, "title": { "type": "string" } } }, "redirects": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "tenant": { "type": "string", "description": "tenants ID" }, "from": { "type": "string" }, "matchType": { "type": "string", "enum": [ "exact", "contains", "prefix" ] }, "to": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "reference", "custom" ] }, "reference": { "type": "string", "description": "pages,events,people,seasons,series,works,venues,organizations,posts,blogs,event-instances ID" }, "url": { "type": "string" } } } }, "required": [ "id" ] }, "forms": { "type": "object", "properties": { "confirmationMessage": { "type": "string" }, "confirmationType": { "type": "string", "enum": [ "message", "redirect" ] }, "fields": { "type": "array", "items": { "type": "object" } }, "redirect": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "reference", "custom" ] }, "reference": { "type": "string", "description": "pages,events ID" }, "url": { "type": "string" } } }, "slug": { "type": "string" }, "submitButtonLabel": { "type": "string" }, "tenant": { "type": "string", "description": "tenants ID" }, "title": { "type": "string" } } }, "ConfiguredFieldBulkMutationRequest": { "type": "object", "allOf": [ { "oneOf": [ { "required": [ "all" ], "properties": { "all": { "const": true } }, "not": { "required": [ "where" ] } }, { "required": [ "where" ], "not": { "required": [ "all" ], "properties": { "all": { "const": true } } } } ] }, { "anyOf": [ { "required": [ "set" ] }, { "required": [ "unset" ] } ] } ], "properties": { "where": { "type": "object", "additionalProperties": true, "description": "Body-level selector using the Partners API where grammar." }, "all": { "type": "boolean", "default": false, "description": "Set to true to intentionally target all documents in the collection." }, "dryRun": { "type": "boolean", "default": false, "description": "Preview the mutation without writing changes." }, "set": { "type": "object", "additionalProperties": true, "minProperties": 1, "propertyNames": { "pattern": "^[^.\\s]+$" }, "description": "Configured field keys and public values to create or update." }, "unset": { "type": "array", "minItems": 1, "items": { "type": "string", "pattern": "^[^.\\s]+$" }, "description": "Configured field keys to remove from matched documents." } } }, "ConfiguredFieldBulkMutationResult": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "updated", "would_update", "unchanged", "failed" ] }, "set": { "type": "array", "items": { "type": "string" } }, "unset": { "type": "array", "items": { "type": "string" } }, "draftSync": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationDraftSync" }, "error": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationResultError" } }, "required": [ "id", "status", "set", "unset" ] }, "ConfiguredFieldBulkMutationResultError": { "type": "object", "properties": { "message": { "type": "string" }, "status": { "type": "integer" } }, "required": [ "message" ] }, "ConfiguredFieldBulkMutationDraftSync": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "updated", "would_update", "unchanged", "skipped", "failed" ] }, "set": { "type": "array", "items": { "type": "string" } }, "unset": { "type": "array", "items": { "type": "string" } }, "error": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationResultError" } }, "required": [ "status", "set", "unset" ] }, "ConfiguredFieldBulkMutationResponse": { "type": "object", "properties": { "dryRun": { "type": "boolean" }, "versionTarget": { "type": "string", "enum": [ "published", "draft" ] }, "matched": { "type": "integer", "minimum": 0 }, "updated": { "type": "integer", "minimum": 0 }, "wouldUpdate": { "type": "integer", "minimum": 0 }, "unchanged": { "type": "integer", "minimum": 0 }, "failed": { "type": "integer", "minimum": 0 }, "draftSynced": { "type": "integer", "minimum": 0 }, "draftWouldSync": { "type": "integer", "minimum": 0 }, "draftSyncSkipped": { "type": "integer", "minimum": 0 }, "draftSyncFailed": { "type": "integer", "minimum": 0 }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ConfiguredFieldBulkMutationResult" } } }, "required": [ "dryRun", "versionTarget", "matched", "updated", "wouldUpdate", "unchanged", "failed", "draftSynced", "draftWouldSync", "draftSyncSkipped", "draftSyncFailed", "results" ] }, "ConfiguredFieldBulkMutationError": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } }, "required": [ "error", "message" ] }, "BlockMutationRequest": { "type": "object", "required": [ "draft", "ifUpdatedAt", "operations" ], "properties": { "draft": { "type": "boolean", "enum": [ true ], "description": "Must be true; block mutations always target the draft version." }, "ifUpdatedAt": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp of the document version this mutation is based on. Rejected with 409 if the document has been updated since." }, "operations": { "type": "array", "minItems": 1, "items": { "type": "object", "additionalProperties": true }, "description": "Ordered list of block operations to apply." } } }, "BlockMutationResponse": { "type": "object", "required": [ "versionTarget", "operations", "document" ], "properties": { "versionTarget": { "type": "string", "enum": [ "draft" ] }, "operations": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "document": { "type": "object", "additionalProperties": true } } }, "BlockMutationError": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object" } }, "requestId": { "type": "string" } } }, "ThemeSettingsMutationRequest": { "type": "object", "required": [ "draft", "ifUpdatedAt" ], "properties": { "draft": { "type": "boolean", "enum": [ true ] }, "ifUpdatedAt": { "type": "string", "format": "date-time" }, "set": { "type": "object", "additionalProperties": true }, "unset": { "type": "array", "items": { "type": "string" } } } }, "ThemeSettingsMutationResponse": { "type": "object", "required": [ "versionTarget", "set", "unset", "document" ], "properties": { "versionTarget": { "type": "string", "enum": [ "draft" ] }, "set": { "type": "array", "items": { "type": "string" } }, "unset": { "type": "array", "items": { "type": "string" } }, "document": { "type": "object" } } }, "PartnerFieldSchema": { "type": "object", "required": [ "key", "type" ], "properties": { "key": { "type": "string" }, "type": { "type": "string", "description": "text, richText, number, checkbox, select, date, relationship, upload, customObject, array, group, …" }, "label": { "type": "string" }, "hasMany": { "type": "boolean" }, "relationTo": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": {}, "label": { "type": "string" } } } }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerFieldSchema" }, "description": "Nested fields for array/group types" } } }, "BlockSchemaResponse": { "type": "object", "properties": { "collection": { "type": "string" }, "blocks": { "type": "array", "items": { "type": "object", "required": [ "type", "fields" ], "properties": { "type": { "type": "string", "description": "Block type to pass as a block's `type`" }, "label": { "type": "string" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerFieldSchema" } } } } } } }, "ConfiguredFieldSchemaResponse": { "type": "object", "required": [ "fields" ], "properties": { "collection": { "type": "string" }, "configurationAvailable": { "type": "boolean" }, "template": { "type": "string", "nullable": true }, "reason": { "type": "string" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerFieldSchema" } } } }, "Error": { "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" } } }, "RateLimitError": { "type": "object", "properties": { "error": { "type": "string", "example": "Too Many Requests" }, "message": { "type": "string", "example": "Rate limit exceeded. Please retry later." } }, "required": [ "error", "message" ] } }, "securitySchemes": { "apiKey": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "Use format: users API-Key YOUR_API_KEY" } } }, "security": [ { "apiKey": [] } ] }