API Playground

GET/api/playground

Renders the interactive API playground: a single self-contained HTML page that lets you try every endpoint of this installation from the browser. The endpoint catalogue is built at runtime from /api/openapi.json, so it always matches the routes this installation really exposes.

The page is a static shell - it carries no CRM data and no token - so it is served without the authtoken header, which a browser cannot send when you navigate to a URL. Paste a token into the toolbar and press Load endpoints: the token is kept in the page's memory only (never in a cookie, localStorage, sessionStorage or the URL, and gone the moment you reload or close the tab) and is attached as the authtoken header to the specification fetch and to every request you send from the page. Requests reach the very same endpoints as any other client, so writes really do change live data - non GET requests ask for confirmation first.

No CSS, JavaScript or font is loaded from a third party host, and the page is served with a Content-Security-Policy that allows code only from the document itself and network calls only back to this installation.

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

Success-Response:

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