Public API
Build on the Public API
A JSON:API-style HTTP interface for reading and writing your Workspace data: CMS collections, native resources such as buildings, events, festivals, jobs, and products, plus specialized commands, asset delivery, and a key-scoped OpenAPI schema.
Everything is scoped to your API key.
Endpoints, fields, filters, and write actions depend on the grants configured for the key in Workspace settings → Integrations → Public API. The interactive reference can load the exact OpenAPI schema for your key.
Getting startedWhat the Einblick Public API is, how it is structured, and how to make your first request.AuthenticationCreate API keys, understand read and write grants, and control browser origins.Resources & responsesNative and CMS resources, collections vs. singletons, and the JSON:API response shape.Pagination & sortingPage through collections with cursors and order results with the sort parameter.Includes (relations)Expand relation fields into full records with the include parameter.Writing dataCreate, update, and delete records with JSON:API write requests and idempotency keys.Assets & filesHow file and image fields are delivered, and how to request on-the-fly image transforms.CommandsSpecialized write flows — job applications, newsletter signups, uploads, and sync operations.OpenAPI schemaFetch the OpenAPI 3.1 document scoped to your API key and generate typed clients.ErrorsThe JSON:API error format and every error code the API returns.