Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,7 @@ There are several ways to support Mautic other than contributing with code.
:hidden:

rest_api/getting_started
rest_api/api_v2
rest_api/authentication
rest_api/assets
rest_api/campaigns
Expand Down
32 changes: 32 additions & 0 deletions docs/rest_api/api_v2.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
Mautic API v2
#############

A quick overview
****************

Mautic introduces a powerful new REST API built on the robust **API Platform** framework. This modern API provides a more flexible, standardized, and well-documented way to interact with your Mautic data.

Accessing the API
*****************

To access the new API, you must authenticate within your Mautic instance.

The base endpoint for the new API is ``/api/v2``.

Once you authenticate, you can start making requests to this endpoint to interact with your Mautic data.

API documentation and discovery
*******************************

The new Mautic API is self-documenting. Navigate to the ``/api/v2`` endpoint in a web browser while logged into Mautic to see comprehensive, interactive API documentation.

.. vale off

This documentation provides a detailed list of all available API endpoints, the supported HTTP methods - such as ``GET``, ``POST``, ``PUT``, or ``DELETE`` - and the accepted parameters. Use the interface to test API calls directly from your browser.

.. vale on

The API supports modern features such as:

* **Pagination:** the API paginates results by default for efficient data retrieval.
* **Multiple data formats:** the API supports various data formats, including ``JSON-LD``, standard ``JSON`` and ``text/html``.
Loading