Insites Docs Instance CRMCRM API Reference

CRM API Reference

Last updated on April 11, 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 instance 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.

MethodOperationDescription
GETGet ContactsRetrieve a list of contacts with filtering, sorting, and pagination. Supports an parameter for exact-match filtering.
GETGet ContactRetrieve a single contact by ID, including profile data.
POSTAdd ContactCreate a new contact record.
PATCHUpdate ContactUpdate an existing contact record.
PATCHArchive ContactArchive a contact without deleting it.
PATCHRestore ContactRestore a previously archived contact.
DELETEDelete ContactPermanently 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:

MethodOperationDescription
POSTAssign Contact ProfilesAssign one or more profiles to a contact.
PATCHUpdate Contact ProfileUpdate 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.

MethodOperationDescription
GETGet CompaniesRetrieve a list of companies with filtering, sorting, and pagination.
GETGet CompanyRetrieve a single company by ID.
POSTAdd CompanyCreate a new company record.
PATCHAssign Contacts to CompanyAssign one or more contacts to a company.
PATCHUpdate CompanyUpdate an existing company record.
PATCHArchive CompanyArchive a company without deleting it.
PATCHRestore CompanyRestore a previously archived company.
DELETEDelete CompanyPermanently delete a company.

Activities API

The Activities API supports full pagination with the following parameters:

ParameterTypeDefaultDescription
Integer1Page number.
Integer10Number of results per page.
Stringlast_updatedField to sort by.
StringDESCSort direction (ASC or DESC).
BooleantrueWhether to include pagination metadata in the response. When enabled, the response includes total pages, total entries, and current page information.
StringnullField to search by.
StringnullSearch keyword.

Google Maps API key

A single endpoint is available for retrieving the Google Maps API key configured on your instance.

MethodEndpointDescription
GET/crm/api/v2/google-mapsRetrieve 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 tag. This lets you display or interact with CRM data on custom pages without making API calls from the browser.

Each API endpoint has a corresponding controller path that can be used within CMS templates. Refer to your instance 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:

ParameterTypeDescription
IntegerPage number for paginated results.
IntegerNumber of results per page.
StringSort direction: ASC or DESC.
StringSearch keyword for filtering results.
Adding, updating, and deleting GeoJSON, media files, and media images via the API is not currently supported for custom fields.
Have a suggestion for this page?

Didn't quite find what you are looking for or have feedback on how we can make the content better then we would love to hear from you. Please provide us feedback and we will get back to you shortly.