Site · API
Insites API Documentation
Last updated 18 November 2026
Every Insites Site comes with built-in API documentation that is automatically generated from the modules and endpoints on your Site. This is your go-to reference for understanding how external systems can interact with your Site. You do not need to write or maintain this documentation yourself; Insites generates it for you.
Accessing the API Documentation
- Navigate to API from the main menu.
- Select Insites API Endpoints.
This opens the API documentation page at <your instance URL>/admin/api.
What the API Documentation Includes
- Module Endpoints - Every module that exposes API endpoints is listed in the sidebar. You can browse endpoints by module, making it easy to find what you need.
- Request Formats - Each endpoint shows the HTTP method, URL, and an example HTTP request you can copy directly into your integration or testing tool.
- Controller Requests - For developers, each endpoint also shows how to call the underlying logic directly from Liquid templates using the
functiontag. - Response Examples - View example responses for each endpoint, showing the data structure you can expect back so you can build your integration with confidence.
- Authentication - The documentation covers how to authenticate your API requests, including the authentication methods supported by your Site.
- Module Versions - A dedicated page shows the version of every module on your Site, giving you a clear picture of what is running. It is shown only when you are signed in.
Using the Documentation
The API documentation is dynamic. It reflects the modules, module versions and endpoints on your specific Site. This means the documentation is always accurate to your Site rather than a generic reference.
The documentation includes a theme switcher so you can view it in light or dark mode, and a sidebar that lists every module and endpoint. Use the sidebar to jump between modules and drill into individual endpoints.
Note
The API documentation is read-only. To create or manage your own endpoints, use Custom API Endpoints. To control access to those endpoints, use Authorization Policies.