Skip to content
LogoLogo

Delivery API

The Delivery API is a public REST API. It is read-only, and it serves the published configuration of your project together with your page content. It is separate from the GraphQL management API.

Base URL and versioning

All Delivery API routes are versioned under /api/v1:

https://api.picked.app/api/v1

Published content and preview content

Each endpoint serves two surfaces:

  • Published content is anonymous. Anybody can read your published configuration and your published content.
  • Preview content needs a preview_token query parameter. With it you can render an unpublished draft before you make it live.

The management API holds the preview token of a workspace in the previewToken field. The preview action in the dashboard also makes one for you.

Endpoints

EndpointDescription
Project ConfigGET /api/v1/projects/:projectId returns the published configuration of the project, with the content link of each step.
Experience ContentGET /api/v1/projects/:projectId/experiences/:id/content returns the Content Entries of an experience.

Both endpoints share some behaviour. See Preview, cache, and crawlers.