Site · CRM
CRM API Reference
Last updated 18 November 2026
The CRM provides a comprehensive set of API endpoints for managing contacts, companies, activities, and related data programmatically. This is useful for integrating Insites with external systems, automating workflows, or building custom interfaces that interact with your CRM data.
The full interactive API documentation, including request and response examples, is available at your site URL/admin/api. The endpoints below highlight key capabilities and usage patterns.
This article discusses the following topics:
- Contacts API
- Contact profiles
- Companies API
- Activities API
- Google Maps API key
- Controller access from CMS
- Common parameters
Contacts API
The Contacts API lets you manage individual contact records. Available operations include listing, creating, updating, archiving, restoring, and deleting contacts.
| Method | Operation | Description |
|---|---|---|
| GET | Get Contacts | Retrieve a list of contacts with filtering, sorting, and pagination. Supports an |
| GET | Get Contact | Retrieve a single contact by ID, including profile data. |
| POST | Add Contact | Create a new contact record. |
| PATCH | Update Contact | Update an existing contact record. |
| POST | Archive Contact | Archive a contact without deleting it. The URL is /crm/api/v2/contacts/:uuid/archive. A PATCH request to this URL returns 405. |
| POST | Restore Contact | Restore an archived contact. The URL is /crm/api/v2/contacts/:uuid/restore. A PATCH request to this URL returns 405. |
| DELETE | Delete Contact | Permanently delete a contact. |
Contact profiles
Profile data is included in all contact API responses. Profiles are returned as a nested object where each key is the profile name. Internal system profiles are filtered out automatically.
Two dedicated endpoints are available for managing profile assignments:
| Method | Operation | Description |
|---|---|---|
| POST | Assign Contact Profiles | Assign one or more profiles to a contact. |
| PATCH | Update Contact Profile | Update the field values of an assigned profile on a contact. |
Companies API
The Companies API lets you manage company records. Available operations include listing, creating, updating, archiving, restoring, and deleting companies, as well as assigning contacts.
| Method | Operation | Description |
|---|---|---|
| GET | Get Companies | Retrieve a list of companies with filtering, sorting, and pagination. |
| GET | Get Company | Retrieve a single company by ID. |
| POST | Add Company | Create a new company record. |
| PATCH | Assign Contacts to Company | Assign one or more contacts to a company. |
| PATCH | Update Company | Update an existing company record. |
| POST | Archive Company | Archive a company without deleting it. The URL is /crm/api/v2/companies/:uuid/archive. A PATCH request to this URL returns 405. |
| POST | Restore Company | Restore an archived company. The URL is /crm/api/v2/companies/:uuid/restore. A PATCH request to this URL returns 405. |
| DELETE | Delete Company | Permanently delete a company. |
Activities API
The Activities API supports full pagination with the following parameters:
| Parameter | Type | Default | Description |
|---|---|---|---|
| Integer | 1 | Page number. | |
| Integer | 10 | Number of results per page. | |
| String | uuid | Field to sort by. | |
| String | ASC | Sort direction (ASC or DESC). | |
| Boolean | true | Whether to include pagination metadata in the response. When enabled, the response includes total pages, total entries, and current page information. | |
| String | type | Field to search by. | |
| String | null | Search keyword. |
Google Maps API key
A single endpoint is available for retrieving the Google Maps API key configured on your site.
| Method | Endpoint | Description |
|---|---|---|
| GET | /crm/api/v2/google-maps | Retrieve the stored Google Maps API key. Returns the key value, or a 404 if no key has been configured. |
Controller access from CMS
CRM data can be accessed directly from CMS page templates and controllers using the Liquid
Each API endpoint has a corresponding controller path that can be used within CMS templates. Refer to your site URL/admin/api for the full list of controller paths and usage examples.
Common parameters
The following parameters are shared across most CRM API endpoints:
| Parameter | Type | Description |
|---|---|---|
| Integer | Page number for paginated results. | |
| Integer | Number of results per page. | |
| String | Sort direction: ASC or DESC. | |
| String | Search keyword for filtering results. |
Note
Adding, updating, and deleting GeoJSON, media files, and media images via the API is not currently supported for custom fields.