API Playground (Swagger UI)

GET/api/swagger

Renders a self-contained Swagger UI page wired to /api/openapi.json. Swagger UI itself is loaded from the jsDelivr CDN, so the browser needs outbound access to cdn.jsdelivr.net. This page is a static HTML shell: it carries no CRM data and no token, so it is served without the authtoken header (a browser cannot send one when you navigate to a URL). The toolbar at the top of the page accepts an authtoken which is kept in the page's memory only - it is never written to cookies, localStorage or sessionStorage - and is injected as the authtoken header on every request Swagger UI makes, including the OpenAPI document fetch. Every endpoint you call from the page is still protected by the normal token check.

curl -X GET "https://yoursite.com/api/swagger" \
  -H "authtoken: YOUR_API_TOKEN"

Success-Response:

HTTP/1.1 200 OK
Content-Type: text/html; charset=UTF-8
MethodGET
Path/api/swagger
GroupTooling
Sincev1.0.0
Defined inRestApi/Controllers/SwaggerController.php