> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/insightly.md).

# Insightly

Insightly CRM platform. Create contacts, manage opportunities, search CRM records, and create follow-up tasks.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Insightly | API Key        |

#### Insightly

Connect to Insightly with an API key and API pod.

**Set up in Insightly**

1. Prepare the Insightly account or service that the workflow will access. Grant access to the required resources and operations.
2. **Pod:** Your Insightly API pod from <https://api.\\><pod>.insightly.com/v3.1/. Find it beside your API key in Insightly user settings.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Insightly**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                  |
| ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Pod           | Yes      | Your Insightly API pod from <https://api.\\><pod>.insightly.com/v3.1/. Find it beside your API key in Insightly user settings. |
| API Key       | Yes      | Your Insightly user API key. [Provider instructions](https://api.insightly.com/v3.1/Help).                                     |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Insightly** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create Contact

Create a contact in Insightly.

**Inputs**

| Field              | Type     | Required | Description                                                    |
| ------------------ | -------- | -------- | -------------------------------------------------------------- |
| First Name         | string   | Yes      | Contact first name.                                            |
| Last Name          | string   | No       | Contact last name.                                             |
| Email Address      | string   | No       | Contact email address.                                         |
| Phone              | string   | No       | Primary contact phone.                                         |
| Organisation ID    | integer  | No       | Insightly organisation ID to associate with the contact.       |
| Owner User ID      | integer  | No       | Insightly owner user ID.                                       |
| Title              | string   | No       | Contact job title.                                             |
| Background         | textarea | No       | Contact background notes.                                      |
| Email Opted Out    | boolean  | No       | Whether the contact opted out of email.                        |
| Custom Fields JSON | code     | No       | JSON object of Insightly custom FIELD\_NAME to value mappings. |

**Outputs**

| Field      | Type    | Description                   |
| ---------- | ------- | ----------------------------- |
| Contact ID | integer | Created Insightly contact ID. |
| Contact    | dict    | Created Insightly contact.    |

#### Create Opportunity

Create an opportunity in Insightly.

**Inputs**

| Field               | Type            | Required | Description                                                                 |
| ------------------- | --------------- | -------- | --------------------------------------------------------------------------- |
| Opportunity Name    | string          | Yes      | Opportunity name.                                                           |
| Opportunity Details | textarea        | No       | Opportunity details.                                                        |
| Opportunity State   | select (string) | No       | Opportunity state. Available values: Open, Won, Lost, Abandoned, Suspended. |
| Organisation ID     | integer         | No       | Related Insightly organisation ID.                                          |
| Owner User ID       | integer         | No       | Insightly owner user ID.                                                    |
| Responsible User ID | integer         | No       | Responsible Insightly user ID.                                              |
| Bid Amount          | number          | No       | Opportunity bid amount.                                                     |
| Bid Currency        | string          | No       | Opportunity bid currency.                                                   |
| Probability         | integer         | No       | Win probability from 0 to 100.                                              |
| Forecast Close Date | string          | No       | Forecast close date in Insightly object-data format.                        |
| Custom Fields JSON  | code            | No       | JSON object of Insightly custom FIELD\_NAME to value mappings.              |

**Outputs**

| Field          | Type    | Description                       |
| -------------- | ------- | --------------------------------- |
| Opportunity ID | integer | Created Insightly opportunity ID. |
| Opportunity    | dict    | Created Insightly opportunity.    |

#### Update Opportunity

Update an opportunity in Insightly.

**Inputs**

| Field               | Type            | Required | Description                                                                     |
| ------------------- | --------------- | -------- | ------------------------------------------------------------------------------- |
| Opportunity ID      | integer         | Yes      | Insightly opportunity ID to update.                                             |
| Opportunity Name    | string          | No       | New opportunity name.                                                           |
| Opportunity Details | textarea        | No       | New opportunity details.                                                        |
| Opportunity State   | select (string) | No       | New opportunity state. Available values: Open, Won, Lost, Abandoned, Suspended. |
| Probability         | integer         | No       | Win probability from 0 to 100.                                                  |
| Stage ID            | integer         | No       | Pipeline stage ID to move the opportunity to.                                   |
| Forecast Close Date | string          | No       | Forecast close date in Insightly object-data format.                            |
| Bid Amount          | number          | No       | Opportunity bid amount.                                                         |
| Bid Currency        | string          | No       | Opportunity bid currency.                                                       |
| Custom Fields JSON  | code            | No       | JSON object of Insightly custom FIELD\_NAME to value mappings.                  |

**Outputs**

| Field          | Type        | Description                                           |
| -------------- | ----------- | ----------------------------------------------------- |
| Opportunity ID | integer     | Updated Insightly opportunity ID.                     |
| Opportunity    | dict        | Updated Insightly opportunity.                        |
| Stage Changes  | dict\_array | Pipeline stage change response returned by Insightly. |

#### Search Records

Search Insightly contacts or opportunities.

**Inputs**

| Field             | Type            | Required | Description                                                            |
| ----------------- | --------------- | -------- | ---------------------------------------------------------------------- |
| Object            | select (string) | Yes      | Insightly object to search. Available values: Contacts, Opportunities. |
| Field Name        | string          | No       | Standard or custom Insightly field name to filter by.                  |
| Field Value       | string          | No       | Value for the selected Insightly field.                                |
| Updated After UTC | string          | No       | Only return records updated after this UTC timestamp.                  |
| Brief             | boolean         | No       | Return only top-level properties. Default: true.                       |
| Skip              | integer         | No       | Number of records to skip. Default: 0.                                 |
| Top               | integer         | No       | Maximum records to return. Insightly maximum is 500. Default: 100.     |
| Count Total       | boolean         | No       | Ask Insightly to return X-Total-Count. Default: true.                  |

**Outputs**

| Field       | Type        | Description                                                  |
| ----------- | ----------- | ------------------------------------------------------------ |
| Records     | dict\_array | Matching Insightly records.                                  |
| Count       | integer     | Number of records returned.                                  |
| Has More    | boolean     | Whether another page may be available.                       |
| Total Count | integer     | Total matching records when Insightly returns X-Total-Count. |

#### Create Task

Create a follow-up task in Insightly.

**Inputs**

| Field               | Type            | Required | Description                                                    |
| ------------------- | --------------- | -------- | -------------------------------------------------------------- |
| Title               | string          | Yes      | Task title.                                                    |
| Owner User ID       | integer         | Yes      | Insightly task owner user ID.                                  |
| Details             | textarea        | No       | Task details.                                                  |
| Opportunity ID      | integer         | No       | Related Insightly opportunity ID.                              |
| Responsible User ID | integer         | No       | Responsible Insightly user ID.                                 |
| Due Date            | string          | No       | Task due date in Insightly object-data format.                 |
| Completed           | boolean         | No       | Whether the task is completed. Default: false.                 |
| Priority            | select (string) | No       | Task priority. Available values: High, Medium, Low.            |
| Status              | string          | No       | Task status.                                                   |
| Custom Fields JSON  | code            | No       | JSON object of Insightly custom FIELD\_NAME to value mappings. |

**Outputs**

| Field   | Type    | Description                |
| ------- | ------- | -------------------------- |
| Task ID | integer | Created Insightly task ID. |
| Task    | dict    | Created Insightly task.    |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/insightly.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
