API endpoints

Every public /api/v1 route as a simple method + path catalog, auth, request hints, and links to matching MCP tools when available.

Auth

• POST/api/v1/en/auth/loginAuthenticate with email and password; returns accessToken

Websites

• GET/api/v1/en/websitesList websites the authenticated platform user can access
• POST/api/v1/en/websitesCreate a website in preview mode from a template or blank

Templates

• GET/api/v1/en/templatesList active website templates with compact summaries
• GET/api/v1/en/templates/{templateId}Get a website template summary (no Puck design payloads)

Docs

• GET/api/v1/en/docsPlatform docs for agents (query: mode=nav|content, path=docs relative path)
• GET/api/v1/en/design-docsDesign surfaces index, content contract, and API endpoint list
• GET/api/v1/en/design-docs/{surface}Design schema for a surface (blocks, fields, shared concepts)
• GET/api/v1/en/design-docs/lifecyclesLifecycle guide, reference, and examples
• GET/api/v1/en/{websiteId}/design-docs/object_componentObject-component design schema scoped to a website

Design

• GET/api/v1/en/{websiteId}/chrome/headerLoad site header chrome design
• PUT/api/v1/en/{websiteId}/chrome/headerSave site header chrome design
• GET/api/v1/en/{websiteId}/chrome/footerLoad site footer chrome design
• PUT/api/v1/en/{websiteId}/chrome/footerSave site footer chrome design
• GET/api/v1/en/{websiteId}/pagesList pages and routes
• POST/api/v1/en/{websiteId}/pagesCreate route + page
• GET/api/v1/en/{websiteId}/pages/{pageId}Get page design
• PUT/api/v1/en/{websiteId}/pages/{pageId}Save page design
• PATCH/api/v1/en/{websiteId}/pages/{pageId}/pathsUpdate localized paths
• DELETE/api/v1/en/{websiteId}/pages/{pageId}Delete empty page/route
• GET/api/v1/en/{websiteId}/page-componentsList page components
• POST/api/v1/en/{websiteId}/page-componentsCreate page component
• GET/api/v1/en/{websiteId}/page-components/{id}Get page component design
• PUT/api/v1/en/{websiteId}/page-components/{id}Save page component design
• DELETE/api/v1/en/{websiteId}/page-components/{id}Delete page component
• GET/api/v1/en/{websiteId}/objects/{objectTypeId}/componentsList object components
• POST/api/v1/en/{websiteId}/objects/{objectTypeId}/componentsCreate object component
• GET/api/v1/en/{websiteId}/objects/{objectTypeId}/components/{id}Get object component design
• PUT/api/v1/en/{websiteId}/objects/{objectTypeId}/components/{id}Save object component design
• DELETE/api/v1/en/{websiteId}/objects/{objectTypeId}/components/{id}Delete object component
• GET/api/v1/en/{websiteId}/email-chrome/headerLoad email header chrome
• PUT/api/v1/en/{websiteId}/email-chrome/headerSave email header chrome
• GET/api/v1/en/{websiteId}/email-chrome/footerLoad email footer chrome
• PUT/api/v1/en/{websiteId}/email-chrome/footerSave email footer chrome

Objects

• GET/api/v1/en/{websiteId}/objectsList object types (full field schema + type metadata)
• POST/api/v1/en/{websiteId}/objectsCreate an object type
• GET/api/v1/en/{websiteId}/objects/{objectTypeId}List or query entries for an object type
• POST/api/v1/en/{websiteId}/objects/{objectTypeId}Create an object entry
• GET/api/v1/en/{websiteId}/objects/{objectTypeId}/definitionGet full object type definition (no lifecycle)
• PATCH/api/v1/en/{websiteId}/objects/{objectTypeId}/definitionPatch object type definition (fieldSchema replaces fully when sent)
• DELETE/api/v1/en/{websiteId}/objects/{objectTypeId}/definitionSoft-delete an object type
• GET/api/v1/en/{websiteId}/objects/{objectTypeId}/permissionsGet public + per-role object permissions for a type
• PUT/api/v1/en/{websiteId}/objects/{objectTypeId}/permissionsReplace public permissions and role slices (superadmin)
• GET/api/v1/en/{websiteId}/objects/{objectTypeId}/lifecycleGet object type lifecycle config (v3 events)
• PUT/api/v1/en/{websiteId}/objects/{objectTypeId}/lifecycleFull replace of object type lifecycle_config
• GET/api/v1/en/{websiteId}/objects/{objectTypeId}/{entryId}Get a single object entry
• PATCH/api/v1/en/{websiteId}/objects/{objectTypeId}/{entryId}Update an object entry
• DELETE/api/v1/en/{websiteId}/objects/{objectTypeId}/{entryId}Delete an object entry

Settings

• GET/api/v1/en/{websiteId}/settingsLoad website name, locales, and domains summary
• PATCH/api/v1/en/{websiteId}/settingsUpdate website display name
• GET/api/v1/en/{websiteId}/localesLoad website locales
• PUT/api/v1/en/{websiteId}/localesUpdate primary and enabled locales
• GET/api/v1/en/{websiteId}/domainsList custom domains
• POST/api/v1/en/{websiteId}/domainsAdd unverified custom domain
• DELETE/api/v1/en/{websiteId}/domains/{domainId}Remove unverified custom domain only
• GET/api/v1/en/{websiteId}/email-settingsLoad SMTP/platform mail settings
• PUT/api/v1/en/{websiteId}/email-settingsUpdate SMTP/platform mail settings
• GET/api/v1/en/{websiteId}/external-linkingList outbound link allowlist
• PUT/api/v1/en/{websiteId}/external-linkingReplace outbound link allowlist
• GET/api/v1/en/{websiteId}/web-integrationsLoad web integrations (verification/analytics). available=false in preview
• PUT/api/v1/en/{websiteId}/web-integrationsReplace web integrations (superadmin; forbidden in preview status)

Access

• GET/api/v1/en/{websiteId}/platform-rolesList website admin roles
• POST/api/v1/en/{websiteId}/platform-rolesCreate custom website admin role
• GET/api/v1/en/{websiteId}/platform-roles/{roleId}Get website admin role
• PUT/api/v1/en/{websiteId}/platform-roles/{roleId}Update custom website admin role
• DELETE/api/v1/en/{websiteId}/platform-roles/{roleId}Delete unused custom website admin role
• GET/api/v1/en/{websiteId}/platform-usersList platform users with website access
• PATCH/api/v1/en/{websiteId}/platform-users/{userId}Change user role to a custom role only
• DELETE/api/v1/en/{websiteId}/platform-users/{userId}Revoke platform user website access
• GET/api/v1/en/{websiteId}/objects/{objectTypeId}/user-rolesList end-user roles (user object types only)
• POST/api/v1/en/{websiteId}/objects/{objectTypeId}/user-rolesCreate end-user role
• GET/api/v1/en/{websiteId}/objects/{objectTypeId}/user-roles/{roleId}Get end-user role
• PUT/api/v1/en/{websiteId}/objects/{objectTypeId}/user-roles/{roleId}Update end-user role
• DELETE/api/v1/en/{websiteId}/objects/{objectTypeId}/user-roles/{roleId}Delete unused end-user role
• POST/api/v1/en/{websiteId}/objects/{objectTypeId}/user-roles/{roleId}/assignAssign end-user role to a website user

Files

• GET/api/v1/en/{websiteId}/filesList files and directories
• POST/api/v1/en/{websiteId}/filesUpload a file (multipart FormData)
• PATCH/api/v1/en/{websiteId}/files/{fileId}Move a file to another directory
• DELETE/api/v1/en/{websiteId}/files/{fileId}Soft-delete a file
• POST/api/v1/en/{websiteId}/files/directoriesCreate a file directory
• PATCH/api/v1/en/{websiteId}/files/directories/{directoryId}Rename or move a directory
• DELETE/api/v1/en/{websiteId}/files/directories/{directoryId}Delete an empty directory

Theme & layout

• GET/api/v1/en/{websiteId}/themeLoad website theme tokens
• PUT/api/v1/en/{websiteId}/themeUpdate theme tokens and dual-theme flag
• GET/api/v1/en/{websiteId}/layoutLoad layout breakpoints and content width
• PUT/api/v1/en/{websiteId}/layoutUpdate layout breakpoints and content width

Insights

• GET/api/v1/en/{websiteId}/statisticsLoad website traffic and content statistics
• GET/api/v1/en/{websiteId}/reportsList object entry moderation reports
• GET/api/v1/en/{websiteId}/reports/{reportId}Get a moderation report
• POST/api/v1/en/{websiteId}/reports/{reportId}/resolveResolve an open moderation report

Feedback

• POST/api/v1/en/platform/feedback/bug-reportSubmit a platform bug report
• POST/api/v1/en/platform/feedback/feature-requestSubmit a platform feature request