<a id="api"></a>

# Wagtail API

Wagtail includes a built-in API module that provides a public-facing, JSON-formatted API to allow retrieving
content as raw field data. This is useful for cases like serving content to
non-web clients (such as a mobile phone app) or pulling content out of Wagtail
for use in another site.

See [RFC 8: Wagtail API](https://github.com/wagtail/rfcs/blob/main/text/008-wagtail-api.md#12---stable-and-unstable-versions)
for full details on our stabilization policy.

Wagtail is built on Django, so you can also use other Django solutions for building APIs such as [with Django Ninja](django-ninja.md#api-ninja) or [with GraphQL](https://github.com/torchbox/wagtail-grapple).

* [Wagtail API v2 configuration guide](v2/configuration.md)
  * [Basic configuration](v2/configuration.md#basic-configuration)
  * [Additional settings](v2/configuration.md#additional-settings)
* [Wagtail API v2 usage guide](v2/usage.md)
  * [Fetching content](v2/usage.md#fetching-content)
  * [Default endpoint fields](v2/usage.md#default-endpoint-fields)
  * [Changes since v1](v2/usage.md#changes-since-v1)
* [How to set up Django Ninja](django-ninja.md)
  * [Basic configuration](django-ninja.md#basic-configuration)
  * [OpenAPI documentation](django-ninja.md#openapi-documentation)
