API Documentation

Every Insites Instance generates API documentation automatically based on its installed modules. This is your primary reference for understanding the endpoints available on your Instance and how to interact with them.

Where to Find It

The API documentation lives at:

/admin/api

In the Instance Admin, navigate to API > Insites API Endpoints to open it.

The documentation is dynamic. It reflects the exact modules and endpoint versions installed on the specific Instance you are working with. Different Instances may expose different endpoints depending on their module configuration.

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 Instance, including the Instance API Key.
• Example HTTP Requests - Copy-ready curl examples for every endpoint, pre-filled with the correct URL and headers for that Instance.
• Example Controller Requests - Each endpoint shows how to call the underlying logic directly from Liquid templates using the function tag. This is useful when building server-side integrations within the Instance 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 Instance.

Using the Controller Request Syntax

The API documentation shows two ways to call each endpoint:

1. HTTP Request - For external systems calling the endpoint over HTTP (e.g. from a third-party application, mobile app, or automation tool).
2. Controller Request - For server-side calls from within the Instance itself, using Liquid templates.

The controller request uses the function tag:

{% function data = 'modules/module_name/controller_name', param1: value1 %}

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 Instance.

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 Instance API Key used for external authentication, see Instance API Key in the Integrations section.