> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Insightly

> How to set up the Insightly connector, plus the actions and events that are available.

![Insightly](https://stackone-logos.com/api/insightly/filled/svg)

v2.1.0[See changelog](https://docs.stackone.com/connectors/insightly/changelog.md)

[77 actions](#actions) · [2 events](#events) · 1 auth method

CRM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/insightly/guides/connector-profile/api-key.md)
>
> Uses HTTP Basic auth with the personal API key as the username and an empty password. The pod (e.g. na1, eu1) is part of...

Optionally, configure receiving Events for Insightly into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/insightly/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/insightly/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

77 actions

ActionDescription

Get Activity Sets`insightly_get_activity_sets`

Returns a paginated list of activity sets with the activities each one schedules.

Get Contacts`insightly_get_contacts`

Returns a paginated list of contacts.

Get Contacts (Filtered)`insightly_get_contacts_filtered`

Searches contacts by a single field name and value.

Get Contact`insightly_get_contact`

Returns full details of a single contact by RECORD\_ID.

Add Contact`insightly_add_contact`

Creates a new contact in Insightly.

Update Contact`insightly_update_contact`

Updates an existing contact. CONTACT\_ID in body identifies which contact.

Delete Contact`insightly_delete_contact`

Permanently deletes a contact by RECORD\_ID.

Get Countries`insightly_get_countries`

Returns the static list of countries used by Insightly addresses.

Get Currencies`insightly_get_currencies`

Returns the static list of currencies supported by Insightly.

Get Custom Fields`insightly_get_custom_fields`

Returns the custom-field metadata defined on the tenant for one object type, including each field's FIELD\_NAME.

Get Emails`insightly_get_emails`

Returns a paginated list of email records, including each EMAIL\_ID.

Get Events`insightly_get_events`

Returns a paginated list of calendar events. Use top/skip for offset pagination, brief for lightweight payloads, and upd...

Get Event`insightly_get_event`

Returns full details of a single calendar event by EVENT\_ID.

Add Event`insightly_add_event`

Creates a new calendar event in Insightly. START\_DATE\_UTC and END\_DATE\_UTC are required.

Update Event`insightly_update_event`

Updates an existing calendar event. EVENT\_ID is sent in the body and identifies the record to update.

Delete Event`insightly_delete_event`

Deletes a calendar event by EVENT\_ID. Returns 202 Accepted on success.

Get Lead Sources`insightly_get_lead_sources`

Returns all lead source definitions configured in the Insightly tenant.

Add Lead Source`insightly_add_lead_source`

Creates a new lead source definition in the Insightly tenant.

Get Lead Statuses`insightly_get_lead_statuses`

Returns all lead status definitions configured in the Insightly tenant.

Add Lead Status`insightly_add_lead_status`

Creates a new lead status definition in the Insightly tenant.

Get Leads`insightly_get_leads`

Returns a paginated list of leads.

Get Leads (Filtered)`insightly_get_leads_filtered`

Searches leads by a single field name and value.

Get Lead`insightly_get_lead`

Returns full details of a single lead by RECORD\_ID.

Add Lead`insightly_add_lead`

Creates a new lead in Insightly. LAST\_NAME, LEAD\_STATUS\_ID, and LEAD\_SOURCE\_ID are required.

Update Lead`insightly_update_lead`

Updates an existing lead. LEAD\_ID in body identifies which lead.

Delete Lead`insightly_delete_lead`

Permanently deletes a lead by RECORD\_ID.

Get Milestones`insightly_get_milestones`

Returns project milestones, each with its MILESTONE\_ID.

Get Notes`insightly_get_notes`

Returns a paginated list of notes. Use top/skip for offset pagination, brief for lightweight payloads, and updated\_after...

Get Note`insightly_get_note`

Returns full details of a single note by NOTE\_ID.

Add Note`insightly_add_note`

Creates a new note in Insightly, attached to a parent record (Contact, Lead, Opportunity, Organisation, or Project).

Update Note`insightly_update_note`

Updates an existing note. NOTE\_ID is sent in the body and identifies the record to update.

Delete Note`insightly_delete_note`

Deletes a note by NOTE\_ID. Returns 202 Accepted on success.

Get Opportunities`insightly_get_opportunities`

Returns a paginated list of opportunities.

Get Opportunities (Filtered)`insightly_get_opportunities_filtered`

Searches opportunities by a single field name and value.

Get Opportunity`insightly_get_opportunity`

Returns full details of a single opportunity by RECORD\_ID.

Add Opportunity`insightly_add_opportunity`

Creates a new opportunity in Insightly.

Update Opportunity`insightly_update_opportunity`

Updates an existing opportunity. OPPORTUNITY\_ID in body identifies which opportunity.

Update Opportunity Pipeline`insightly_update_opportunity_pipeline`

Puts an opportunity into a pipeline at a chosen stage.

Update Opportunity Pipeline Stage`insightly_update_opportunity_pipeline_stage`

Moves an opportunity to another stage of its current pipeline.

Delete Opportunity`insightly_delete_opportunity`

Permanently deletes an opportunity by RECORD\_ID.

Get Opportunity Categories`insightly_get_opportunity_categories`

Returns the opportunity categories configured in the tenant, each with its CATEGORY\_ID.

Get Organisations`insightly_get_organisations`

Returns a paginated list of organisations.

Get Organisations (Filtered)`insightly_get_organisations_filtered`

Searches organisations by a single field name and value.

Get Organisation`insightly_get_organisation`

Returns full details of a single organisation by RECORD\_ID.

Add Organisation`insightly_add_organisation`

Creates a new organisation in Insightly.

Update Organisation`insightly_update_organisation`

Updates an existing organisation. ORGANISATION\_ID in body identifies which organisation.

Delete Organisation`insightly_delete_organisation`

Permanently deletes an organisation by RECORD\_ID.

Get Pipeline Stages`insightly_get_pipeline_stages`

Returns a paginated list of pipeline stages.

Get Pipeline Stage`insightly_get_pipeline_stage`

Returns full details of a pipeline stage by STAGE\_ID.

Get Pipelines`insightly_get_pipelines`

Returns a paginated list of pipelines.

Get Pipeline`insightly_get_pipeline`

Returns full details of a pipeline by PIPELINE\_ID.

Get Products`insightly_get_products`

Use this for unfiltered browsing of products. For exact-match filtering by a specific field value, use get\_products\_filt...

Get Products (Filtered)`insightly_get_products_filtered`

Search products by a specific field name and value with offset pagination.

Get Product`insightly_get_product`

Returns full details of a single product by PRODUCT\_ID.

Add Product`insightly_add_product`

Creates a new product in Insightly. PRODUCT\_NAME, DEFAULT\_PRICE, and ACTIVE are required; provide other fields as needed...

Update Product`insightly_update_product`

Updates an existing product. PRODUCT\_ID in body identifies which product.

Delete Product`insightly_delete_product`

Permanently deletes a product by PRODUCT\_ID.

Get Projects`insightly_get_projects`

Returns a paginated list of projects. Use top/skip for offset pagination, brief for lightweight payloads, and updated\_af...

Get Projects (Filtered)`insightly_get_projects_filtered`

Search projects by a specific field name and value with offset pagination.

Get Project`insightly_get_project`

Returns full details of a single project by PROJECT\_ID.

Add Project`insightly_add_project`

Creates a new project in Insightly. PROJECT\_NAME and STATUS are required; provide other fields as needed.

Update Project`insightly_update_project`

Updates an existing project. PROJECT\_ID is sent in the body and identifies the record to update.

Delete Project`insightly_delete_project`

Deletes a project by PROJECT\_ID. Returns 202 Accepted on success.

Get Project Categories`insightly_get_project_categories`

Returns the project categories configured in the tenant, each with its CATEGORY\_ID.

Get Tags`insightly_get_record_tags`

Returns the tags attached to one specific Insightly record. Insightly also exposes an account-wide GET /Tags listing, wh...

Get Tasks`insightly_get_tasks`

Returns a paginated list of tasks. Use top/skip for offset pagination, brief for lightweight payloads, and updated\_after...

Get Tasks (Filtered)`insightly_get_tasks_filtered`

Search tasks by a specific field name and value with offset pagination.

Get Task`insightly_get_task`

Returns full details of a single task by TASK\_ID.

Add Task`insightly_add_task`

Creates a new task in Insightly. TITLE, COMPLETED, and OWNER\_USER\_ID are required; provide other fields as needed.

Update Task`insightly_update_task`

Updates an existing task. TASK\_ID is sent in the body and identifies the record to update.

Delete Task`insightly_delete_task`

Deletes a task by TASK\_ID. Returns 202 Accepted on success.

Get Task Categories`insightly_get_task_categories`

Returns the task categories configured in the tenant, each with its CATEGORY\_ID.

Get Teams`insightly_get_teams`

Returns a paginated list of teams, including each team's TEAM\_ID.

Add Team`insightly_add_team`

Creates a team and returns its server-minted TEAM\_ID.

Get Users`insightly_get_users`

Returns a paginated list of users in the Insightly instance.

Get User`insightly_get_user`

Returns full details of a user by USER\_ID.

Get Current User`insightly_get_current_user`

Returns the authenticated user's record.

## Events

Tags

Select all
|
Clear

Health Check

Webhooks

No tags found

2 events

EventDescriptionTags

Active Check`insightly_active_check`

Responds to a manual connectivity test when the webhook URL is called with `?event=ping` or with no request body. Insigh...

Health Check

Insightly Webhook`insightly_webhook_event`

Processes inbound Insightly Workflow Automation webhook events.

Webhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.