Developers · APIs
API Documentation
Last updated 18 November 2026
Every Insites Site generates API documentation automatically based on its installed modules. This is your primary reference for understanding the endpoints available on your Site and how to interact with them.
Where to Find It
The API documentation lives at:
<your-instance-url>/admin/apiIn the Site Admin, navigate to API > Insites API Endpoints to open it.
The documentation is dynamic. It reflects the exact module versions installed on the specific Site you are working with. Sites with different module versions may expose different endpoints.
What It Covers
The documentation includes:
- Endpoints by Module - The sidebar organizes all available API endpoints by module (CRM, Data, Events, Forms, etc.). Each endpoint shows its HTTP method, URL, parameters, and example request/response.
- Authentication - How to authenticate API requests to the Site, including the Site API Key.
- Example HTTP Requests - Copy-ready curl examples for every endpoint, pre-filled with the correct URL and headers for that Site.
- Example Controller Requests - Each endpoint shows how to call the underlying logic directly from Liquid templates using the
functiontag. This is useful when building server-side integrations within the Site itself. - Example Responses - Structured JSON response examples showing the data format returned by each endpoint.
- Module Versions - A dedicated page listing all installed module versions on the Site.
Using the Controller Request Syntax
The API documentation shows two ways to call each endpoint:
- HTTP Request - For external systems calling the endpoint over HTTP (e.g. from a third-party application, mobile app, or automation tool).
- Controller Request - For server-side calls from within the Site itself, using Liquid templates.
The controller request uses the function tag:
{% function data = 'crm/controller/contacts/create', params: params %}Use the controller alias shown in /admin/api, never the file path. The alias stays the same between module versions; the file behind it can move.
This calls the endpoint logic directly without making an HTTP roundtrip, which is faster and avoids authentication overhead when you are already executing code on the Site.
Cross-References
- For calling API endpoint logic directly from Liquid templates, see Controllers.
- For managing Custom API Endpoints, see Custom API Endpoints in the user guide.
- For securing endpoints with Authorization Policies, see Authorization Policies in the user guide.
- For managing GraphQL queries, see GraphQL in the user guide.
- For the Site API Key used for external authentication, see Site API Key in the Integrations section.
Note
The API documentation at /admin/api is read-only. To create your own Custom API Endpoints, manage Authorization Policies, or work with GraphQL queries, use the corresponding sections under API in the Site Admin.