Skip to content

API V2 Documentation. #261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: 5.x
Choose a base branch
from
Open

API V2 Documentation. #261

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
31b631d
API V2 Documentation.
nileshlohar Aug 22, 2025
b85074e
Merge branch '5.x' into api-v2-doc
RCheesley Oct 11, 2025
38922a8
Improvements.
nileshlohar Oct 13, 2025
d3b4fbd
Improvements
nileshlohar Oct 13, 2025
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
36 changes: 36 additions & 0 deletions docs/rest_api/api-v2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
Mautic API v2
#############

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

Mautic introduces a powerful new REST API built on the robust **API Platform** framework.

Check warning on line 7 in docs/rest_api/api-v2.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Acronyms] Spell out 'REST', if it's unfamiliar to the audience.

Raw Output:
{"message": "[Google.Acronyms] Spell out 'REST', if it's unfamiliar to the audience.", "location": {"path": "docs/rest_api/api-v2.rst", "range": {"start": {"line": 7, "column": 34}}}, "severity": "INFO"}
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.
This means that you can simply navigate to the ``/api/v2`` endpoint in your web browser while logged into Mautic, and you see comprehensive and interactive API documentation.

This documentation provides a detailed list of all available API endpoints, the http methods they support (GET, POST, PUT, DELETE, etc.), and the parameters they accept.
You can even use this interface to test API calls directly from your browser.


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.