Skip to main content

Table of Contents

Adapto CMS Public API Documentation

Complete developer reference for the Adapto CMS Public API. All endpoints are read-only and require an API key for authentication.

Base URL: https://public-api.adaptocms.com

Getting Started

Page

Description

Introduction

Overview of Adapto CMS, the Public API, quick start guide, and available resources.

Authentication

How to obtain and use your API key, security best practices, and authentication errors.

Pagination, Sorting & Filtering

Common query parameters for pagination, sorting, filtering, and preview endpoints.

Client Development

Page

Description

SDK Reference

SDK methods, type definitions, caching, retries, CDN rewriting, and media hydration.

Next.js Starter

Integrating all content types into a Next.js 16 App Router project.

SvelteKit Starter

Integrating all content types into a SvelteKit 2 + Svelte 5 project.

Astro Starter

Integrating all content types into a fully static Astro project using Content Collections.

API Reference

Page

Endpoints

Description

Articles API

5 endpoints

List, get by ID/slug, previews, and translations for blog posts and long-form content.

Categories API

6 endpoints

List, get by ID/slug, subcategories, articles in category, and translations.

Pages API

4 endpoints

List, get by ID/slug, previews for static pages with hierarchical structure.

Custom Collections API

7 endpoints

List collections, get by ID/slug, list/get items by ID/slug, item previews.

Micro Copy API

6 endpoints

List, get by ID/key/language, count, and translations for UI text snippets.

Search API

1 endpoint

Full-text search across articles, pages, and collection items.

Available Languages API

1 endpoint

List all languages with published content.

Reference

Page

Description

Data Models

Complete reference for all response models, field types, and schema definitions.

Error Handling

HTTP status codes, validation errors, rate limiting, and error handling best practices.

CLI & AI Agents

The adapto CLI, environment variable authentication, llm-info for AI agent context, and common workflows.

Integrating Webhooks

Configuring webhooks, delivery payload format, and HMAC signature verification.

Integrating GitHub Workflows

Triggering GitHub Actions workflow_dispatch events from the backoffice.

Migrating Content

Migrating articles, pages, collections, and media from other CMS platforms using the CLI and an AI agent.

Backups

Creating and restoring project backups from the backoffice.

All Public Endpoints at a Glance

Method

Endpoint

Description

GET

/v1/articles

List articles

GET

/v1/articles/preview

List article previews

GET

/v1/articles/{id}

Get article by ID

GET

/v1/articles/by-slug/{slug}

Get article by slug

GET

/v1/articles/{id}/translations

Get article translations

GET

/v1/categories

List categories

GET

/v1/categories/{id}

Get category by ID

GET

/v1/categories/by-slug/{slug}

Get category by slug

GET

/v1/categories/{id}/subcategories

Get subcategories

GET

/v1/categories/{id}/articles

Get articles in category

GET

/v1/categories/{id}/translations

Get category translations

GET

/v1/pages

List pages

GET

/v1/pages/preview

List page previews

GET

/v1/pages/{id}

Get page by ID

GET

/v1/pages/by-slug/{slug}

Get page by slug

GET

/v1/custom-collections

List collections

GET

/v1/custom-collections/{id}

Get collection by ID

GET

/v1/custom-collections/by-slug/{slug}

Get collection by slug

GET

/v1/custom-collections/{id}/items

List collection items

GET

/v1/custom-collections/{id}/items/preview

List item previews

GET

/v1/custom-collections/{id}/items/{item_id}

Get item by ID

GET

/v1/custom-collections/{id}/items/by-slug/{slug}

Get item by slug

GET

/v1/micro-copy

List micro copy

GET

/v1/micro-copy/{id}

Get micro copy by ID

GET

/v1/micro-copy/by-key/{key}

Get micro copy by key

GET

/v1/micro-copy/language/{lang}

Get micro copy by language

GET

/v1/micro-copy/count

Count micro copy entries

GET

/v1/micro-copy/translations/{id}

Get micro copy translations

GET

/v1/search

Full-text search

GET

/v1/available-languages

Get available languages