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. Sign in to your instance admin as an administrator
2. Go to Integrations, then Instance API Key (https://[your-instance-url]/admin/insites#/integrations/instance-api-key)
3. Copy the key. It starts with instance_

Using the API Key

Send the key as it is in the Authorization header of every request, for example Authorization: instance_abc123. Do not add Bearer. A Bearer prefix fails with 401.

Base URL

Module API endpoints use this format: https://[your-instance-url]/[module]/api/v2/[resource]. For example, https://[your-instance-url]/crm/api/v2/contacts.

API Documentation

Your instance provides built-in interactive API documentation at:

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

This documentation is generated by the instance. It lists every module API on the instance and every field each endpoint returns. You can read it without signing in.