API Overview

Insites provides a RESTful API accessible over HTTPS, enabling developers to read and manage data stored within their Insites instance. The API is designed for creating automated integrations, custom workflows, or server-to-server communication.

The Insites API uses standard HTTP methods and returns JSON-encoded responses.

Authentication

All API requests must include an Authorization header containing your instance API key.

Obtaining Your API Key

1. Log in to your Insites Instance Admin
2. Navigate to Settings in the left sidebar
3. Locate the API Access section
4. Copy the API key displayed

Using the API Key

Include the API key in the Authorization header of every request

Base URL

All API endpoints use the following base URL format, where the prefix is your unique instance identifier

API Documentation

Your instance provides built-in interactive API documentation at:

https://[your-instance-url]/admin/api

This documentation is dynamically generated based on the modules installed on your instance. If you add or remove a module, the API documentation will reflect those changes immediately.