API Key

API URL

Insightly

Please, fill in the fields in the form below

_objects

Contacts

Lead Statuses

Leads

Opportunities

Organisations

Pipeline Stages

Pipelines

Project Categories

Projects

Users

Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.

Gets a list of records

If you have trouble updating a record, try accessing the record via the GET request to inspect its fields and sub-elements. A common source of            problems with write/update requests occurs when users either omit required fields, or insert invalid data into a field (for example, by referring a            CATEGORY_ID or LINK_ID which does not exist.

Updates a record

If you have trouble with creating a record, try creating records via the web interface, and then access those records via the API. This way you            can see examples of the fields and sub-elements attached to the record. A common source of problems during write/update request is caused when users omit            required fields, or insert invalid data in a field (e.g. reference a CATEGORY_ID that does not exist in the user's Insightly instance.

Adds a record

Gets a record

Deletes a Record

Gets a record's translation in a specific language

Updates a record's translation in a specific language

Adds a Translation for a record in a specific language

To filter with a field name and value, both field_name and field_value parameters must be provided.            <br /> Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.

Gets a filtered list of records

Gets a list of Activity Sets

Gets a single Activity Set

If you have trouble updating a Comment, try accessing the Comment via the GET request to inspect its fields and sub-elements. A common source of            problems with write/update requests occurs when users either omit required fields, or insert invalid data into a field (for example, by referring a            CATEGORY_ID or LINK_ID which does not exist.

Updates a Comment

Deletes a Comment

Gets a Comment's File Attachments

This endpoint expects multipart/form-data as the request payload. See Stack Overflow for examples of how to generate multipart requests, or see our <a href="http://github.com/Insightly" target="_blank">client libraries</a> for an example of how this is generated. Only one file can be added per request.

Adds a File Attachment to a Comment

Gets a list of Forum Comments

If you have trouble updating a Forum Comment, try accessing the Forum Comment via the GET request to inspect its fields and sub-elements. A common source of            problems with write/update requests occurs when users either omit required fields, or insert invalid data into a field (for example, by referring a            CATEGORY_ID or LINK_ID which does not exist.

Updates a Forum Comment

If you have trouble with creating a Forum Comment, try creating Forum Comments via the web interface, and then access those Forum Comments via the API. This way you            can see examples of the fields and sub-elements attached to the Forum Comment. A common source of problems during write/update request is caused when users omit            required fields, or insert invalid data in a field (e.g. reference a CATEGORY_ID that does not exist in the user's Insightly instance.

Adds a Forum Comment

Gets a Forum Comment

Gets a Follow state for a Forum Comment

Start following a Forum Comment

Stop following a Forum Comment

Gets a filtered list of Forum Comments

Gets a list of Forums

If you have trouble updating a Forum, try accessing the Forum via the GET request to inspect its fields and sub-elements. A common source of            problems with write/update requests occurs when users either omit required fields, or insert invalid data into a field (for example, by referring a            CATEGORY_ID or LINK_ID which does not exist.

Updates a Forum

If you have trouble with creating a Forum, try creating Forums via the web interface, and then access those Forums via the API. This way you            can see examples of the fields and sub-elements attached to the Forum. A common source of problems during write/update request is caused when users omit            required fields, or insert invalid data in a field (e.g. reference a CATEGORY_ID that does not exist in the user's Insightly instance.

Adds a Forum

Gets a Forum

Gets a list of Forum Posts of a Forum

Updates a Forum Post of a Forum

Adds a Forum Post to a Forum

Gets a Follow state for a Forum

Start following a Forum

Stop following a Forum

Gets a filtered list of Forums

Gets a list of Forum Posts

If you have trouble updating a Forum Post, try accessing the Forum Post via the GET request to inspect its fields and sub-elements. A common source of            problems with write/update requests occurs when users either omit required fields, or insert invalid data into a field (for example, by referring a            CATEGORY_ID or LINK_ID which does not exist.

Updates a Forum Post

If you have trouble with creating a Forum Post, try creating Forum Posts via the web interface, and then access those Forum Posts via the API. This way you            can see examples of the fields and sub-elements attached to the Forum Post. A common source of problems during write/update request is caused when users omit            required fields, or insert invalid data in a field (e.g. reference a CATEGORY_ID that does not exist in the user's Insightly instance.

Adds a Forum Post

Gets a Forum Post

Gets a list of Forum Comments of a Forum Post

Updates a Forum Comment of a Forum Post

Adds a Forum Comment to a Forum Post

Gets a Follow state for a Forum Post

Start following a Forum Post

Stop following a Forum Post

Gets a filtered list of Forum Posts

Gets a list of Contacts

If you have trouble updating a Contact, try accessing the Contact via the GET request to inspect its fields and sub-elements. A common source of            problems with write/update requests occurs when users either omit required fields, or insert invalid data into a field (for example, by referring a            CATEGORY_ID or LINK_ID which does not exist.

Updates a Contact

If you have trouble with creating a Contact, try creating Contacts via the web interface, and then access those Contacts via the API. This way you            can see examples of the fields and sub-elements attached to the Contact. A common source of problems during write/update request is caused when users omit            required fields, or insert invalid data in a field (e.g. reference a CATEGORY_ID that does not exist in the user's Insightly instance.

Adds a Contact

Gets a Contact

Deletes a Contact

Adds an Activity Set to a Contact

Gets a Contact's Dates

Updates a Contact's Dates

Gets a list of a Contact's Emails

Gets a Contact's Events

Gets a Contact's File Attachments

Adds a File Attachment to a Contact

Gets a Follow state for a Contact

Start following a Contact

Stop following a Contact

Gets a Contact's Image

Deletes a Contact's Image

This action will replace any existing Image attached to the Contact. The contents of the image data should be sent as binary data in the request payload. See our <a href="http://github.com/Insightly" target="_blank">client libraries</a> for an example of how this is done.

Updates a Contact's Image

Gets a Contact's Custom Image Field

Deletes a Contact's Custom Image Field

This action will replace any existing Image attached to the Contact's image field. The contents of the image data should be sent as binary data in the request payload. See our <a href="http://github.com/Insightly" target="_blank">client libraries</a> for an example of how this is done.

Updates a Contact's Custom Image Field

Gets a Contact's Links

Updates a Link

Adds a Link

Deletes a Link

Gets a list of Notes of a Contact

Updates a Note of a Contact

Adds a Note to a Contact

Deletes a Note of a Contact

Gets a Contact's Notes

Updates a note of a Contact

Gets a Contact's Tags

Updates a Contact's Tags

Adds a Tag to a Contact

Deletes a Tag from a Contact

Gets a list of a Contact's Tasks

Gets a filtered list of Contacts

Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.

Gets a list of Contacts filtered by tags

This read only endpoint returns a list of the countries Insightly recognizes for use in addresses.

Gets a list of Countries used by Insightly

This read only endpoint returns a list of the currencies and currency symbols currently recognized by Insightly.

Gets a list of Currencies used by Insightly

Use this API call to get a list of custom fields metadata. The properties FIELD_NAME and FIELD_ORDER can be used to determine which fields belong to a particular object. A common problem API users have is to reference an invalid FIELD_NAME when referencing custom fields in a newly created or updated object.            If you plan to use custom fields in your API based application, be sure you are working with valid custom field names. To add or update custom fields for your Insightly instance, you'll need to go to the web app to do so.

Gets a list of Custom Fields

This read only endpoint returns a custom field by name.

Gets a Custom Field by name

This read only endpoint returns a list of the custom objects.

Gets a list of custom objects

This read only endpoint returns a custom object by name.

Gets a custom object by object name

Gets a list of Emails

Gets an Email

Deletes an Email

Gets an Email's Comments

Adds a Comment to an Email

Gets an Email's File Attachments

Gets a Follow state for an Email

Start following an Email

Stop following an Email

Gets an Email's Links

Salesforce

HubSpot

Microsoft Dynamics 365

Zoho CRM

Pipedrive

Freshsales

Keap

SugarCRM

Outreach

Xero

ActiveCampaign

Capsule CRM

Salesloft

Agile CRM

SalesForce Pardot

SharpSpring

Teamleader

Zendesk

Sage Accounting

Attio

Copper

Intercom

Zoho Books

Front

Close

Freshdesk

Breezy HR

Affinity

Exact Online

Mautic

# Realtime Full two-way Sync of Companies

This scenario enables your application to fully sync Companies between your app and any external application in both directions. It handles the initial import/export of Companies and then sends events when a Company is created, updated, or deleted on any side, as close to real-time as possible.

Company fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Companies in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Companies to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Companies

Bi-directional realtime sync of Companies with records deduplication

Mailchimp

NetSuite

AWeber

Apollo.io

GoHighLevel

Ontraport

Jobnimbus

# Continuous Import of Contacts to Your App

This scenario enables your application to continuously sync Contacts from any external application to your app's API. It handles the initial import of Contacts and keeps them synchronized when a Contact is created, updated, or deleted in the external application.

When receiving Contacts data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Contacts to my App

Import Contacts and receive created/updated or deleted events

Microsoft Sharepoint

Monday

Slack

Jira

Asana

Github

Notion

Clickup

Microsoft Teams

Greenhouse Harvest

Calendly

BambooHR

Basecamp

Okta

Deel

Lever

Google Workspace

Microsoft Entra ID

# Continuous Import of Users to Your App

This scenario enables your application to continuously sync Users from any external application to your app's API. It handles the initial import of Users and keeps them synchronized when a User is created, updated, or deleted in the external application.

When receiving Users data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Users to my App

Import Users and receive created/updated or deleted events

Insightly API Integration Profile

Data Collections

Operations

Integration Scenarios

Two-way realtime sync of Companies

Continuously Import Contacts to my App

Continuously Import Users to my App

Update Lead

Update Project

Create Project

Use the same code to integrate with Insightly and 100+ other applications

Contacts

Companies

Users

Deals

Leads

Build every single integration your customers need with AI

	Contacts automatically maps to	Companies automatically maps to	Users automatically maps to	Deals automatically maps to	Leads automatically maps to
Microsoft Dynamics 365	Contacts	Accounts	Systemusers	Opportunities	Leads
Zoho CRM	Contacts	Accounts	Users	Deals	Leads
Salesforce	Contacts	Accounts	Users	Opportunities	Leads
Teamleader	Contacts	Companies	Users	Deals	—
Keap	Contacts	Companies	Users	Opportunities	—
Pipedrive	Leads	Organizations	Users	Deals	—
Agile CRM	Contacts	Companies	Users	Deals	—
SugarCRM	Contacts	Accounts	Users	Opportunities	—
Freshsales	Contacts	Accounts	Owners	Deals	—
Capsule CRM	People	Organisations	Users	Opportunities	—