Wagtail API v2

The Wagtail REST API v2 exposes site content — pages, images, documents, and redirects — as JSON. Endpoints support filtering by field value, tree relationships (child_of, ancestor_of, descendant_of), locale, and site. Full-text search, field selection, and cursor-based pagination via limit and offset are built in. Custom page models can expose additional fields through the api_fields attribute. Authentication is optional and configurable via Django REST Framework.

API entry from apis.yml

apis.yml Raw ↑
aid: wagtail:wagtail-api-v2
name: Wagtail API v2
description: 'The Wagtail REST API v2 exposes site content — pages, images, documents, and redirects —
  as JSON. Endpoints support filtering by field value, tree relationships (child_of, ancestor_of, descendant_of),
  locale, and site. Full-text search, field selection, and cursor-based pagination via limit and offset
  are built in. Custom page models can expose additional fields through the api_fields attribute. Authentication
  is optional and configurable via Django REST Framework.

  '
image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg
humanURL: https://docs.wagtail.org/en/latest/advanced_topics/api/
baseURL: https://{your-wagtail-site}/api/v2/
tags:
- CMS
- Content Management
- Pages
- Images
- Documents
- REST API
- Django
- Python
- Headless CMS
properties:
- type: Documentation
  url: https://docs.wagtail.org/en/latest/advanced_topics/api/v2/usage.html
- type: Configuration
  url: https://docs.wagtail.org/en/latest/advanced_topics/api/v2/configuration.html
contact:
- FN: Wagtail Community
  url: https://wagtail.org/slack
  email: [email protected]