From 31b631d7124836ac8f901987dc54badfc2f193e2 Mon Sep 17 00:00:00 2001 From: Nilesh Lohar Date: Fri, 22 Aug 2025 19:56:17 +0530 Subject: [PATCH 1/3] API V2 Documentation. --- docs/rest_api/api-v2.rst | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 docs/rest_api/api-v2.rst diff --git a/docs/rest_api/api-v2.rst b/docs/rest_api/api-v2.rst new file mode 100644 index 00000000..9a7c5a86 --- /dev/null +++ b/docs/rest_api/api-v2.rst @@ -0,0 +1,36 @@ +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 will need to be authenticated within your Mautic instance. + +The base endpoint for the new API is: ``/api/v2`` + +Once you are authenticated, 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 will be presented with 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:** Results are paginated by default for efficient data retrieval. +* **Multiple Data Formats:** The API supports various data formats, including JSON-LD, standard JSON and text/html. From 38922a83ffe8c6569efbaf92db3d7a9ec451150e Mon Sep 17 00:00:00 2001 From: Nilesh Lohar Date: Mon, 13 Oct 2025 13:49:11 +0530 Subject: [PATCH 2/3] Improvements. --- docs/rest_api/api-v2.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/rest_api/api-v2.rst b/docs/rest_api/api-v2.rst index 9a7c5a86..17869f26 100644 --- a/docs/rest_api/api-v2.rst +++ b/docs/rest_api/api-v2.rst @@ -1,10 +1,10 @@ -Mautic API V2 +Mautic API v2 ############# -A Quick Overview +A quick overview **************** -Mautic introduces a powerful new REST API built on the robust **API Platform** framework. +Mautic introduces a powerful new REST (Representational State Transfer) 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. ---- @@ -12,25 +12,25 @@ This modern API provides a more flexible, standardized, and well-documented way Accessing the API ***************** -To access the new API, you will need to be authenticated within your Mautic instance. +To access the new API, you must authenticate within your Mautic instance. The base endpoint for the new API is: ``/api/v2`` -Once you are authenticated, you can start making requests to this endpoint to interact with your Mautic data. +Once you authenticate, you can start making requests to this endpoint to interact with your Mautic data. ---- -API Documentation and Discovery +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 will be presented with comprehensive and interactive API documentation. +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. +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:** Results are paginated by default for efficient data retrieval. -* **Multiple Data Formats:** The API supports various data formats, including JSON-LD, standard JSON and text/html. +* **Pagination:** results are paginated by default for efficient data retrieval. +* **Multiple Data Formats:** The API supports various data formats, including JSON-LD, standard JSON and text/HTML. From d3b4fbdb71a292de9a7edfd53eeaf3e53a35646f Mon Sep 17 00:00:00 2001 From: Nilesh Lohar Date: Mon, 13 Oct 2025 14:37:14 +0530 Subject: [PATCH 3/3] Improvements --- docs/rest_api/api-v2.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/rest_api/api-v2.rst b/docs/rest_api/api-v2.rst index 17869f26..69db4606 100644 --- a/docs/rest_api/api-v2.rst +++ b/docs/rest_api/api-v2.rst @@ -4,7 +4,7 @@ Mautic API v2 A quick overview **************** -Mautic introduces a powerful new REST (Representational State Transfer) API built on the robust **API Platform** framework. +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. ---- @@ -20,7 +20,7 @@ Once you authenticate, you can start making requests to this endpoint to interac ---- -Api documentation and discovery +API documentation and discovery ******************************* The new Mautic API is self-documenting. @@ -32,5 +32,5 @@ You can even use this interface to test API calls directly from your browser. The API supports modern features such as: -* **Pagination:** results are paginated by default for efficient data retrieval. -* **Multiple Data Formats:** The API supports various data formats, including JSON-LD, standard JSON and text/HTML. +* **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.