Insightly integrationInsightly logo

Insightly integration for AI agents.

Insightly integration for AI agents with secure authentication and server-side credential injection. Open Connector runs the OAuth, seals the token in an encrypted vault, and serves Insightly tools to your agent over MCP or a typed API — credentials injected server-side, every call audited, nothing leaving your infrastructure. Open source (AGPL-3.0) and self-hostable.

What your agents can do

Real Insightly actions, managed and audited.

Your user connects Insightly once; your agent can then use Insightly API to manage CRM contacts, organisations, opportunities, leads, projects, tasks, events, notes, and related records — scoped to the OAuth permissions you grant and the tool allowlist you configure. Every action is least-privilege and written to a tamper-evident audit trail.

  1. 1

    Your user grants Insightly access once (OAuth) — the token lands in the vault.

  2. 2

    Your agent calls a tool over MCP or the typed API; Open Connector injects the credential server-side.

  3. 3

    Every routed call appends a hash-chained audit record — nothing leaves your infra.

Tools & triggers

Supported Insightly tools.

527 tools are generated from the published Insightly catalog. Descriptions are plain text; each action remains subject to its configured authentication and tool allowlist.

Showing 527 tools. All published catalog entries are included in this page's server-rendered HTML.

Adds an Activity Set to a Contact
Adds an Activity Set to a Contact
Contacts
Adds a Forum Post to a Forum
Adds a Forum Post to a Forum
Forums
Adds a Comment to an Email
Adds a Comment to an Email
Emails
Insightly Object Screen Pop
This endpoint loads Insightly object page within the client browser running Insightly for convenience and increased productivity.
Cti
AddDisplayTicketOnClient
AddDisplayTicketOnClient
Cti
Adds 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.
CustomObjectsRecords
Adds a Structured Custom Event
PROSPECT_ID, CATEGORY, and ACTION are all required when creating an event. These are used to properly categorize and score the event.
MarketingCustomEvents
Adds a File Attachment to a Record
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. Some file types are not allowed for security reasons.
CustomObjectsRecords
Adds a File Category
This endpoint is used to create a new File Category. This endpoint is only accessible to users with administrator permission.
FileCategories
Start following a Forum Comment
Start following a Forum Comment
ForumComments
Adds a Lead Source
This endpoint is used to define a new lead source. This endpoint is only accessible to users with administrator access.
LeadSources
Adds a Lead Status
This endpoint is used to add a new lead status option to the instance. This endpoint is only accessible to users with administrator access.
LeadStatuses
Adds a Link
Adds a Link
Contacts
Merges the Ticket into another Ticket
Merges the Ticket into another Ticket
Tickets
Adds a Milestone
Adds a Milestone
Projects
Adds a Note to 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.
Contacts
Adds an Opportunity Category
This endpoint is used to create a new opportunity category. This endpoint is only accessible to users with administrator permission.
OpportunityCategories
Adds a Project Category
This endpoint is used to create a new project category. This endpoint is only accessible to users with administrator permission.
ProjectCategories
Adds a Prospect to a static list
Adds a Prospect to a static list
Prospects
Adds a Tag to a Contact
Adds a Tag to a Contact
Contacts
Adds a Task Category
This endpoint is used to create a new task category. This endpoint is only accessible to users with administrator permission.
TaskCategories
Adds a Team
TEAM_NAME is required when creating a Team with ANONYMOUS_TEAM set to "false". When creating Anonymous Teams, e.g. ANONYMOUS_TEAM=true, you must include all the Team Members that should be part of the team. A minimum of one Team Member is required. For more details, please refer to GET /Teams above.
Teams
Adds a new Team Member
Note: Team Members of Anonymous Teams can only be created via the /Teams endpoint.
TeamMembers
Adds a Translation for a record in a specific language
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.
CustomObjectsRecords
Deletes a Forum Post of a Forum
Deletes a Forum Post of a Forum
Forums
Deletes a Record
Deletes a Record
CustomObjectsRecords
Deletes a File Attachment
Deletes a File Attachment
FileAttachments
Deactivates a File Category
This endpoint is used to deactivate an existing File Category. This endpoint is only accessible to users with administrator permission.
FileCategories
Stop following a Forum Comment
Stop following a Forum Comment
ForumComments
Deletes a Contact's Image
Deletes a Contact's Image
Contacts
Deletes a Contact's Custom Image Field
Deletes a Contact's Custom Image Field
Contacts
Deletes a Lead Source
This endpoint is used to delete an existing lead source.
LeadSources
Deletes a Lead Status
This endpoint is used to delete an existing lead status.
LeadStatuses
Deletes a Link
Deletes a Link
Contacts
Deletes a Milestone
Deletes a Milestone
Projects
Deactivates an Opportunity Category
The endpoint is used to deactivate an existing opportunity category. This endpoint is only accessible to users with administrator permission.
OpportunityCategories
Clears pipeline for the Opportunity
Clears pipeline for the Opportunity
Opportunities
Deactivates a Project Category
This endpoint is used to deactivate an existing project category. This endpoint is only accessible to users with administrator permission.
ProjectCategories
Removes a Prospect from a static list
Removes a Prospect from a static list
Prospects
Deletes a Tag from a Contact
Deletes a Tag from a Contact
Contacts
Deactivates a Task Category
This endpoint is used to deactivate a task category. This endpoint is only accessible to users with administrator permission.
TaskCategories
Deletes a Team
Deletes a Team
Teams
Deletes a Team Member
Note: Team Members of Anonymous Teams can only be deleted via the /Teams endpoint.
TeamMembers
Deletes a Comment
Deletes a Comment
Comments
Stop following a Forum
Stop following a Forum
Forums
Deletes a Forum Comment of a Forum Post
Deletes a Forum Comment of a Forum Post
ForumPosts
Stop following a Forum Post
Stop following a Forum Post
ForumPosts
Deletes a Contact
Deletes a Contact
Contacts
Stop following a Contact
Stop following a Contact
Contacts
Deletes an Email
Deletes an Email
Emails
Stop following an Email
Stop following an Email
Emails
Deletes a Link
Deletes a Link
Emails
Deletes a Tag from an Email
Deletes a Tag from an Email
Emails
Deletes an Event
Deletes an Event
Events
Deletes an Event's Custom Image Field
Deletes an Event's Custom Image Field
Events
Deletes a Link
Deletes a Link
Events
Stop following a Forum Category
Stop following a Forum Category
ForumCategories
Deletes a Knowledge Article
Deletes a Knowledge Article
KnowledgeArticles
Stop following a Knowledge Article
Stop following a Knowledge Article
KnowledgeArticles
Deletes a Knowledge Article's Custom Image Field
Deletes a Knowledge Article's Custom Image Field
KnowledgeArticles
Deletes a Tag from a Knowledge Article
Deletes a Tag from a Knowledge Article
KnowledgeArticles
Deletes a Lead
Deletes a Lead
Leads
Stop following a Lead
Stop following a Lead
Leads
Deletes a Lead's Image
Deletes a Lead's Image
Leads
Deletes a Lead's Custom Image Field
Deletes a Lead's Custom Image Field
Leads
Deletes a Tag from a Lead
Deletes a Tag from a Lead
Leads
Deletes a Note
Deletes a Note
Notes
Deletes a Comment of a Note
Deletes a Comment of a Note
Notes
Stop following a Note
Stop following a Note
Notes
Deletes a Link
Deletes a Link
Notes
Deletes an Opportunity
Deletes an Opportunity
Opportunities
Stop following an Opportunity
Stop following an Opportunity
Opportunities
Deletes an Opportunity's Image
Deletes an Opportunity's Image
Opportunities
Deletes an Opportunity's Custom Image Field
Deletes an Opportunity's Custom Image Field
Opportunities
Deletes a Link
Deletes a Link
Opportunities
Deletes an Opportunity Product of an Opportunity
Deletes an Opportunity Product of an Opportunity
Opportunities
Deletes a Tag from an Opportunity
Deletes a Tag from an Opportunity
Opportunities
Deletes an Opportunity Product's Custom Image Field
Deletes an Opportunity Product's Custom Image Field
OpportunityProducts
Deletes an Organisation
Deletes an Organisation
Organisations
Stop following an Organisation
Stop following an Organisation
Organisations
Deletes an Organisation's Image
Deletes an Organisation's Image
Organisations
Deletes an Organisation's Custom Image Field
Deletes an Organisation's Custom Image Field
Organisations
Deletes a Link
Deletes a Link
Organisations
Deletes a Tag from an Organisation
Deletes a Tag from an Organisation
Organisations
Deletes a Price Book Entry's Custom Image Field
Deletes a Price Book Entry's Custom Image Field
PriceBookEntries
Stop following a Price Book
Stop following a Price Book
PriceBooks
Deletes a Price Book Entry of a Price Book
Deletes a Price Book Entry of a Price Book
PriceBooks
Deletes a Product
Deletes a Product
Products
Stop following a Product
Stop following a Product
Products
Deletes a Product's Image
Deletes a Product's Image
Products
Deletes a Product's Custom Image Field
Deletes a Product's Custom Image Field
Products
Deletes a Price Book Entry of a Product
Deletes a Price Book Entry of a Product
Products
Deletes a Project
Deletes a Project
Projects
Stop following a Project
Stop following a Project
Projects
Deletes a Project's Image
Deletes a Project's Image
Projects
Deletes a Project's Custom Image Field
Deletes a Project's Custom Image Field
Projects
Deletes a Link
Deletes a Link
Projects
Clears pipeline for the Project
Clears pipeline for the Project
Projects
Deletes a Tag from a Project
Deletes a Tag from a Project
Projects
Deletes a Prospect
Deletes a Prospect
Prospects
Stop following a Prospect
Stop following a Prospect
Prospects
Deletes a Prospect's Custom Image Field
Deletes a Prospect's Custom Image Field
Prospects
Deletes a Tag from a Prospect
Deletes a Tag from a Prospect
Prospects
Deletes a Quote
Deletes a Quote
Quotes
Stop following a Quote
Stop following a Quote
Quotes
Deletes a Quote's Custom Image Field
Deletes a Quote's Custom Image Field
Quotes
Deletes a Quote Document of a Quote
Deletes a Quote Document of a Quote
Quotes
Deletes a Quote Product of a Quote
Deletes a Quote Product of a Quote
Quotes
Deletes a Quote Product's Custom Image Field
Deletes a Quote Product's Custom Image Field
QuoteProducts
Deletes a Task
Deletes a Task
Tasks
Stop following a Task
Stop following a Task
Tasks
Deletes a Task's Custom Image Field
Deletes a Task's Custom Image Field
Tasks
Deletes a Link
Deletes a Link
Tasks
Deletes a Team Member
Deletes a Team Member
Teams
Deletes a Ticket
Deletes a Ticket
Tickets
Stop following a Ticket
Stop following a Ticket
Tickets
Deletes a Ticket's Custom Image Field
Deletes a Ticket's Custom Image Field
Tickets
Deletes a Tag from a Ticket
Deletes a Tag from a Ticket
Tickets
Generates a new Merge Document
Returns the generated document. If the 'format' parameter is set to 'JSON', returns the metadata of the associated File Attachment in JSON format.
CustomObjectsRecords
Gets a single Activity Set
Gets a single Activity Set
ActivitySets
Gets a list of Activity Sets
Gets a list of Activity Sets
ActivitySets
Gets a list of Forum Posts of a Forum
Gets a list of Forum Posts of a Forum
Forums
Gets an Email's Comments
Gets an Email's Comments
Emails
Gets a list of Countries used by Insightly
This read only endpoint returns a list of the countries Insightly recognizes for use in addresses.
Countries
Gets a list of Currencies used by Insightly
This read only endpoint returns a list of the currencies and currency symbols currently recognized by Insightly.
Currencies
Gets a list of Custom Fields
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.
CustomFields
Gets a list of custom objects
This read only endpoint returns a list of the custom objects.
CustomObjects
Gets a Custom Field by name
This read only endpoint returns a custom field by name.
CustomFields
Gets a Contact's Dates
Gets a Contact's Dates
Contacts
Gets an Organisation's Email Domains
Gets an Organisation's Email Domains
Organisations
Gets a list of a Contact's Emails
Gets a list of a Contact's Emails
Contacts
Gets a list of records
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
CustomObjectsRecords
Gets a filtered list of records
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.
CustomObjectsRecords
Gets a list of Contacts filtered by tags
Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.
Contacts
Gets a record
Gets a record
CustomObjectsRecords
Gets a Contact's Events
Gets a Contact's Events
Contacts
Gets a File Attachment
Returns the requested File Attachment. If the 'format' parameter is set to 'JSON', returns the metadata of the File Attachment in JSON format.
FileAttachments
Gets a Record's File Attachments
Gets a Record's File Attachments
CustomObjectsRecords
Gets a list of File Categories
This read only endpoint returns a list of file categories that have been set up for the Insightly instance.
FileCategories
Gets a File Category
This endpoint returns the graph for a specific file category.
FileCategories
Gets a Follow state for a Forum Comment
Gets a Follow state for a Forum Comment
ForumComments
Gets a list of followed records for the user
Gets a list of followed records for the user
Follows
Gets a Contact's Image
Gets a Contact's Image
Contacts
Gets a Contact's Custom Image Field
Gets a Contact's Custom Image Field
Contacts
Gets the Instance
Gets the Instance
Instance
Gets a list of Lead Sources
This endpoint returns a list of the lead sources that have been defined on the Insightly instance.
LeadSources
Gets a list of Lead Statuses
This endpoint returns a list of the possible lead statuses that have been defined for the Insightly instance.
LeadStatuses
Gets the email address to use for linking with the Lead
An email address to use as a mail drop for the Lead.
Leads
Gets a Contact's Links
Gets a Contact's Links
Contacts
Gets a list of Marketing Visits
Gets a list of Marketing Visits
MarketingVisits
Gets a list of Marketing Visits by prospect
Gets a list of Marketing Visits by prospect
MarketingVisits
Gets a list of a Project's Milestones
Gets a list of a Project's Milestones
Projects
Gets a Contact's Notes
Gets a Contact's Notes
Contacts
Gets a list of Opportunity Categories
This read only endpoint returns a list of opportunity categories set up for the Insightly instance.
OpportunityCategories
Gets an Opportunity Category
This endpoint returns the graph for a specific opportunity category
OpportunityCategories
Gets a list of Opportunity State Reasons
This endpoint returns a list of opportunity state reasons set up for the Insightly instance. This is a read only endpoint, so to add or update opportunity state reasons, you will need to do that via the web app. Opportunity state reasons are used to indicate why the opportunity state was set to its current value. For example, you can use this to indicate why you lost a particular sale.
OpportunityStateReasons
Gets the Permissions for a User
Permissions determine if an individual user can read, edit, delete, or create records of a given object type.
Permissions
Gets a Pipeline
This endpoint returns the graph for a specific pipeline.
Pipelines
Gets a Pipeline Stage
This endpoint returns the graph for a specific pipeline stage.
PipelineStages
Gets a list of Pipeline Stages
This read only endpoint returns a list of the pipeline stages that have been set up for the Insightly instance. Pipeline stages are used to indicate where a project or opportunity is in terms of its progression. For example, stage 1 for the sales pipeline might be "initial contact", while stage 4 might be "generating quote". The API for pipeline stages is read only, so to create or update pipeline stages, you'll need to use the web app to do so.
PipelineStages
Gets a list of Pipelines
This read only endpoint returns a list of pipelines that have been set up for the Insightly instance. Pipelines can be defined for both projects and opportunities, and are used to track the progression of projects and opportunities. To create and update pipelines, you'll need to go to the web app (API access is read-only).
Pipelines
Gets a list of Project Categories
This read only endpoint returns a list of the project categories that have been configured for the Insightly instance.
ProjectCategories
Gets a Project Category
This endpoint is used to retrieve the graph for a specific project category.
ProjectCategories
Gets a list of Relationships
This read only endpoint returns a list of the relationships that have been defined for the Insightly instance. Relationships enable users to define how one Insightly object is related to another. For example: contact A is a customer of contact B. The API only supports read access to relationships, to create or update relationships, you'll need to do so via the web app.
Relationships
Gets the history of States and Reasons for an Opportunity.
Gets the history of States and Reasons for an Opportunity.
Opportunities
Gets a Prospect's static list memberships
Gets a Prospect's static list memberships
Prospects
Gets a Contact's Tags
Gets a Contact's Tags
Contacts
Gets a list of Task Categories
This read only endpoint returns a list of the task categories set up for the Insightly instance.
TaskCategories
Gets a Task Category
This endpoint returns the graph for a specific task category.
TaskCategories
Gets a list of a Contact's Tasks
Gets a list of a Contact's Tasks
Contacts
Gets a Team
Gets a Team
Teams
Gets a Team Member
Gets a Team Member
TeamMembers
Gets a list of Team Members
Gets a list of Team Members
TeamMembers
Gets a list of Teams.
Simple object graphs (excluding TEAMMEMBERS) are returned if "brief=true" is used in the query string. <br /> The API responses may contain two types of Teams: a) regular Teams configured via System Settings and b) so called Anonymous Teams which are created by the system when you set a record permission visible to Individuals. You can differentiate these two types on Teams by the ANONYMOUS_TEAM property. Anonymous Teams are a bit more restricted when it comes to modifying them via the API, they can only be created/updated/deleted via the root /Teams endpoint.
Teams
Gets a record's translation in a specific language
Gets a record's translation in a specific language
CustomObjectsRecords
Gets a User
This read only endpoint returns the details for a specific user on an Insightly instance, same fields as returned by the /Users endpoint, but only for a single identified user.
Users
Gets the User object for the calling user.
This read only endpoint returns the details for the currently authenticated user on an Insightly instance, same fields as returned by the /Users endpoint, but only for a single identified user.
Users
Gets a list of Users
This is a read only endpoint that returns a list of users associated with an Insightly instance. Use this endpoint when you need to obtain a list of valid USER_IDs, for example, when you want to assign a task to a specific user (do not confuse the USER_ID with their CONTACT_ID).
Users
Gets a filtered list of Users
This is a read only endpoint that returns a list of users associated with an Insightly instance. Use this endpoint when you need to obtain a list of valid USER_IDs, for example, when you want to assign a task to a specific user (do not confuse the USER_ID with their CONTACT_ID). <br /> To filter with a field name and value, both field_name and field_value parameters must be provided. <br /> For other filters, only one optional parameter (excluding brief, top, skip and count_total) can be specified. <br /> Simple object graphs (excluding NOTELINKS) are returned if "brief=true" is used in the query string.
Users
Gets a Comment's File Attachments
Gets a Comment's File Attachments
Comments
Gets a list of Forum Comments
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
ForumComments
Gets a Forum Comment
Gets a Forum Comment
ForumComments
Gets a filtered list of Forum Comments
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.
ForumComments
Gets a list of Forums
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
Forums
Gets a Forum
Gets a Forum
Forums
Gets a Follow state for a Forum
Gets a Follow state for a Forum
Forums
Gets a filtered list of Forums
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.
Forums
Gets a list of Forum Posts
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
ForumPosts
Gets a Forum Post
Gets a Forum Post
ForumPosts
Gets a list of Forum Comments of a Forum Post
Gets a list of Forum Comments of a Forum Post
ForumPosts
Gets a Follow state for a Forum Post
Gets a Follow state for a Forum Post
ForumPosts
Gets a filtered list of Forum Posts
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.
ForumPosts
Gets a list of Contacts
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
Contacts
Gets a Contact
Gets a Contact
Contacts
Gets a Contact's File Attachments
Gets a Contact's File Attachments
Contacts
Gets a Follow state for a Contact
Gets a Follow state for a Contact
Contacts
Gets a filtered list of Contacts
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.
Contacts
Gets a custom object by object name
This read only endpoint returns a custom object by name.
CustomObjects
Gets a list of Document Templates
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
DocumentTemplates
Gets a Document Template
Gets a Document Template
DocumentTemplates
Gets a filtered list of Document Templates
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.
DocumentTemplates
Gets a list of Emails
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
Emails
Gets an Email
Gets an Email
Emails
Gets an Email's File Attachments
Gets an Email's File Attachments
Emails
Gets a Follow state for an Email
Gets a Follow state for an Email
Emails
Gets an Email's Links
Gets an Email's Links
Emails
Gets an Email's Tags
Gets an Email's Tags
Emails
Gets a filtered list of Emails
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.
Emails
Gets a list of Emails filtered by tags
Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.
Emails
Gets a list of Events
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
Events
Gets an Event
Gets an Event
Events
Gets an Event's Custom Image Field
Gets an Event's Custom Image Field
Events
Gets an Event's Links
Gets an Event's Links
Events
Gets a filtered list of Events
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.
Events
Gets a list of Forum Categories
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
ForumCategories
Gets a Forum Category
Gets a Forum Category
ForumCategories
Gets a Follow state for a Forum Category
Gets a Follow state for a Forum Category
ForumCategories
Gets a filtered list of Forum Categories
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.
ForumCategories
Gets a list of Knowledge Articles
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
KnowledgeArticles
Gets a list of Knowledge Article Categories
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
KnowledgeArticleCategories
Gets a Knowledge Article Category
Gets a Knowledge Article Category
KnowledgeArticleCategories
Gets a filtered list of Knowledge Article Categories
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.
KnowledgeArticleCategories
Gets a list of Knowledge Article Folders
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
KnowledgeArticleFolders
Gets a Knowledge Article Folder
Gets a Knowledge Article Folder
KnowledgeArticleFolders
Gets a filtered list of Knowledge Article Folders
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.
KnowledgeArticleFolders
Gets a Knowledge Article
Gets a Knowledge Article
KnowledgeArticles
Gets a Follow state for a Knowledge Article
Gets a Follow state for a Knowledge Article
KnowledgeArticles
Gets a Knowledge Article's Custom Image Field
Gets a Knowledge Article's Custom Image Field
KnowledgeArticles
Gets a Knowledge Article's Tags
Gets a Knowledge Article's Tags
KnowledgeArticles
Gets a Knowledge Article's translation in a specific language
Gets a Knowledge Article's translation in a specific language
KnowledgeArticles
Gets a filtered list of Knowledge Articles
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.
KnowledgeArticles
Gets a list of Knowledge Articles filtered by tags
Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.
KnowledgeArticles
Gets a list of Leads
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
Leads
Gets a Lead
Gets a Lead
Leads
Gets a list of a Lead's Emails
Gets a list of a Lead's Emails
Leads
Gets a Lead's Events
Gets a Lead's Events
Leads
Gets a Lead's File Attachments
Gets a Lead's File Attachments
Leads
Gets a Follow state for a Lead
Gets a Follow state for a Lead
Leads
Gets a Lead's Image
Gets a Lead's Image
Leads
Gets a Lead's Custom Image Field
Gets a Lead's Custom Image Field
Leads
Gets a Lead's Notes
Gets a Lead's Notes
Leads
Gets a Lead's Tags
Gets a Lead's Tags
Leads
Gets a list of a Lead's Tasks
Gets a list of a Lead's Tasks
Leads
Gets a filtered list of Leads
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.
Leads
Gets a list of Leads filtered by tags
Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.
Leads
Gets a list of Milestones
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
Milestones
Gets a Milestone
Gets a Milestone
Milestones
Gets a filtered list of Milestones
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.
Milestones
Gets a list of Notes
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
Notes
Gets a Note
Gets a Note
Notes
Gets a list of Comments of a Note
Gets a list of Comments of a Note
Notes
Gets a Note's Comments
Gets a Note's Comments
Notes
Gets a Note's File Attachments
Gets a Note's File Attachments
Notes
Gets a Follow state for a Note
Gets a Follow state for a Note
Notes
Gets a Note's Links
Gets a Note's Links
Notes
Gets a filtered list of Notes
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.
Notes
Gets a list of Opportunities
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
Opportunities
Gets an Opportunity
Gets an Opportunity
Opportunities
Gets a list of an Opportunity's Emails
Gets a list of an Opportunity's Emails
Opportunities
Gets an Opportunity's Events
Gets an Opportunity's Events
Opportunities
Gets an Opportunity's File Attachments
Gets an Opportunity's File Attachments
Opportunities
Gets a Follow state for an Opportunity
Gets a Follow state for an Opportunity
Opportunities
Gets an Opportunity's Image
Gets an Opportunity's Image
Opportunities
Gets an Opportunity's Custom Image Field
Gets an Opportunity's Custom Image Field
Opportunities
Gets the email address to use for linking with the Opportunity
An email address to use as a mail drop for the Opportunity.
Opportunities
Gets an Opportunity's Links
Gets an Opportunity's Links
Opportunities
Gets an Opportunity's Notes
Gets an Opportunity's Notes
Opportunities
Gets a list of Opportunity Products of an Opportunity
Gets a list of Opportunity Products of an Opportunity
Opportunities
Gets an Opportunity's Tags
Gets an Opportunity's Tags
Opportunities
Gets a list of an Opportunity's Tasks
Gets a list of an Opportunity's Tasks
Opportunities
Gets a filtered list of Opportunities
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.
Opportunities
Gets a list of Opportunities filtered by tags
Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.
Opportunities
Gets a list of Opportunity Products
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
OpportunityProducts
Gets an Opportunity Product
Gets an Opportunity Product
OpportunityProducts
Gets an Opportunity Product's Custom Image Field
Gets an Opportunity Product's Custom Image Field
OpportunityProducts
Gets a filtered list of Opportunity Products
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.
OpportunityProducts
Gets a list of Organisations
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
Organisations
Gets an Organisation
Gets an Organisation
Organisations
Gets an Organisation's Dates
Gets an Organisation's Dates
Organisations
Gets a list of an Organisation's Emails
Gets a list of an Organisation's Emails
Organisations
Gets an Organisation's Events
Gets an Organisation's Events
Organisations
Gets an Organisation's File Attachments
Gets an Organisation's File Attachments
Organisations
Gets a Follow state for an Organisation
Gets a Follow state for an Organisation
Organisations
Gets an Organisation's Image
Gets an Organisation's Image
Organisations
Gets an Organisation's Custom Image Field
Gets an Organisation's Custom Image Field
Organisations
Gets an Organisation's Links
Gets an Organisation's Links
Organisations
Gets an Organisation's Notes
Gets an Organisation's Notes
Organisations
Gets an Organisation's Tags
Gets an Organisation's Tags
Organisations
Gets a list of an Organisation's Tasks
Gets a list of an Organisation's Tasks
Organisations
Gets a filtered list of Organisations
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.
Organisations
Gets a list of Organisations filtered by tags
Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.
Organisations
Gets a list of Price Books
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
PriceBooks
Gets a list of Price Book Entries
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
PriceBookEntries
Gets a Price Book Entry
Gets a Price Book Entry
PriceBookEntries
Gets a Price Book Entry's Custom Image Field
Gets a Price Book Entry's Custom Image Field
PriceBookEntries
Gets a filtered list of Price Book Entries
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.
PriceBookEntries
Gets a Price Book
Gets a Price Book
PriceBooks
Gets a Follow state for a Price Book
Gets a Follow state for a Price Book
PriceBooks
Gets a list of Price Book Entries of a Price Book
Gets a list of Price Book Entries of a Price Book
PriceBooks
Gets a filtered list of Price Books
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.
PriceBooks
Gets a list of Products
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
Products
Gets a Product
Gets a Product
Products
Gets a Follow state for a Product
Gets a Follow state for a Product
Products
Gets a Product's Image
Gets a Product's Image
Products
Gets a Product's Custom Image Field
Gets a Product's Custom Image Field
Products
Gets a list of Price Book Entries of a Product
Gets a list of Price Book Entries of a Product
Products
Gets a filtered list of Products
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.
Products
Gets a list of Projects
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
Projects
Gets a Project
Gets a Project
Projects
Gets a list of a Project's Emails
Gets a list of a Project's Emails
Projects
Gets a Project's Events
Gets a Project's Events
Projects
Gets a Project's File Attachments
Gets a Project's File Attachments
Projects
Gets a Follow state for a Project
Gets a Follow state for a Project
Projects
Gets a Project's Image
Gets a Project's Image
Projects
Gets a Project's Custom Image Field
Gets a Project's Custom Image Field
Projects
Gets the email address to use for linking with the Project
An email address to use as a mail drop for the Project.
Projects
Gets a Project's Links
Gets a Project's Links
Projects
Gets a Project's Notes
Gets a Project's Notes
Projects
Gets a Project's Tags
Gets a Project's Tags
Projects
Gets a list of a Project's Tasks
Gets a list of a Project's Tasks
Projects
Gets a filtered list of Projects
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.
Projects
Gets a list of Projects filtered by tags
Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.
Projects
Gets a list of Prospects
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
Prospects
Gets a Prospect
Gets a Prospect
Prospects
Gets a Follow state for a Prospect
Gets a Follow state for a Prospect
Prospects
Gets a Prospect's Custom Image Field
Gets a Prospect's Custom Image Field
Prospects
Gets a Prospect's Tags
Gets a Prospect's Tags
Prospects
Gets a filtered list of Prospects
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.
Prospects
Gets a list of Prospects filtered by tags
Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.
Prospects
Gets a list of Quotes
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
Quotes
Gets a Quote
Gets a Quote
Quotes
Gets a Follow state for a Quote
Gets a Follow state for a Quote
Quotes
Gets a Quote's Custom Image Field
Gets a Quote's Custom Image Field
Quotes
Gets a list of Quote Documents of a Quote
Gets a list of Quote Documents of a Quote
Quotes
Gets a list of Quote Products of a Quote
Gets a list of Quote Products of a Quote
Quotes
Gets a list of Quote Products
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
QuoteProducts
Gets a Quote Product
Gets a Quote Product
QuoteProducts
Gets a Quote Product's Custom Image Field
Gets a Quote Product's Custom Image Field
QuoteProducts
Gets a filtered list of Quote Products
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.
QuoteProducts
Gets a filtered list of Quotes
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.
Quotes
Gets a list of Tags used for a record type
This endpoint returns a list of tags associated with a record type. The endpoint expects the query parameter record_type=contacts|leads|opportunities|organisations|projects|emails, so to fetch a list of tags associated with contacts, your query would be /Tags?record_type=contacts
Tags
Gets a list of Tasks
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
Tasks
Gets a Task
Gets a Task
Tasks
Gets a Task's Comments
Gets a Task's Comments
Tasks
Gets a Follow state for a Task
Gets a Follow state for a Task
Tasks
Gets a Task's Custom Image Field
Gets a Task's Custom Image Field
Tasks
Gets a Task's Links
Gets a Task's Links
Tasks
Gets a filtered list of Tasks
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.
Tasks
Gets a list of Tickets
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
Tickets
Gets a Ticket
Gets a Ticket
Tickets
Gets a Ticket's Comments
Gets a Ticket's Comments
Tickets
Gets a Follow state for a Ticket
Gets a Follow state for a Ticket
Tickets
Gets a Ticket's Custom Image Field
Gets a Ticket's Custom Image Field
Tickets
Gets a Ticket's Tags
Gets a Ticket's Tags
Tickets
Gets a filtered list of Tickets
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.
Tickets
Gets a list of Tickets filtered by tags
Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.
Tickets
Adds a File Attachment to a Comment
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. Some file types are not allowed for security reasons.
Comments
Adds 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.
ForumComments
Adds 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.
Forums
Start following a Forum
Start following a Forum
Forums
Adds 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.
ForumPosts
Adds a Forum Comment to a Forum Post
Adds a Forum Comment to a Forum Post
ForumPosts
Start following a Forum Post
Start following a Forum Post
ForumPosts
Adds 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.
Contacts
Adds a File Attachment to a Contact
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. Some file types are not allowed for security reasons.
Contacts
Start following a Contact
Start following a Contact
Contacts
Generates a new Merge Document
Returns the generated document. If the 'format' parameter is set to 'JSON', returns the metadata of the associated File Attachment in JSON format.
Contacts
Start following an Email
Start following an Email
Emails
Adds a Link
Adds a Link
Emails
Adds a Tag to an Email
Adds a Tag to an Email
Emails
Adds an Event
If you have trouble with creating an Event, try creating Events via the web interface, and then access those Events via the API. This way you can see examples of the fields and sub-elements attached to the Event. 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.
Events
Adds a Link
Adds a Link
Events
Start following a Forum Category
Start following a Forum Category
ForumCategories
Adds a Knowledge Article
If you have trouble with creating a Knowledge Article, try creating Knowledge Articles via the web interface, and then access those Knowledge Articles via the API. This way you can see examples of the fields and sub-elements attached to the Knowledge Article. 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.
KnowledgeArticles
Adds a Knowledge Article Category
If you have trouble with creating a Knowledge Article Category, try creating Knowledge Article Categories via the web interface, and then access those Knowledge Article Categories via the API. This way you can see examples of the fields and sub-elements attached to the Knowledge Article Category. 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.
KnowledgeArticleCategories
Adds a Knowledge Article Folder
If you have trouble with creating a Knowledge Article Folder, try creating Knowledge Article Folders via the web interface, and then access those Knowledge Article Folders via the API. This way you can see examples of the fields and sub-elements attached to the Knowledge Article Folder. 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.
KnowledgeArticleFolders
Start following a Knowledge Article
Start following a Knowledge Article
KnowledgeArticles
Adds a Tag to a Knowledge Article
Adds a Tag to a Knowledge Article
KnowledgeArticles
Adds a Translation for a Knowledge Article in a specific language
If you have trouble with creating a Knowledge Article, try creating Knowledge Articles via the web interface, and then access those Knowledge Articles via the API. This way you can see examples of the fields and sub-elements attached to the Knowledge Article. 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.
KnowledgeArticles
Adds a Lead
If you have trouble with creating a Lead, try creating Leads via the web interface, and then access those Leads via the API. This way you can see examples of the fields and sub-elements attached to the Lead. 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.
Leads
Adds an Activity Set to a Lead
Adds an Activity Set to a Lead
Leads
Adds a File Attachment to a Lead
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. Some file types are not allowed for security reasons.
Leads
Start following a Lead
Start following a Lead
Leads
Generates a new Merge Document
Returns the generated document. If the 'format' parameter is set to 'JSON', returns the metadata of the associated File Attachment in JSON format.
Leads
Adds a Note to a Lead
If you have trouble with creating a Lead, try creating Leads via the web interface, and then access those Leads via the API. This way you can see examples of the fields and sub-elements attached to the Lead. 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.
Leads
Adds a Tag to a Lead
Adds a Tag to a Lead
Leads
Adds a Comment to a Note
Adds a Comment to a Note
Notes
Adds a Comment to a Note
Adds a Comment to a Note
Notes
Adds a File Attachment to a Note
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. Some file types are not allowed for security reasons.
Notes
Start following a Note
Start following a Note
Notes
Adds a Link
Adds a Link
Notes
Adds an Opportunity
If you have trouble with creating an Opportunity, try creating Opportunities via the web interface, and then access those Opportunities via the API. This way you can see examples of the fields and sub-elements attached to the Opportunity. 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.
Opportunities
Adds an Activity Set to an Opportunity
Adds an Activity Set to an Opportunity
Opportunities
Adds a File Attachment to an Opportunity
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. Some file types are not allowed for security reasons.
Opportunities
Start following an Opportunity
Start following an Opportunity
Opportunities
Adds a Link
Adds a Link
Opportunities
Generates a new Merge Document
Returns the generated document. If the 'format' parameter is set to 'JSON', returns the metadata of the associated File Attachment in JSON format.
Opportunities
Adds a Note to an Opportunity
If you have trouble with creating an Opportunity, try creating Opportunities via the web interface, and then access those Opportunities via the API. This way you can see examples of the fields and sub-elements attached to the Opportunity. 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.
Opportunities
Adds an Opportunity Product to an Opportunity
Adds an Opportunity Product to an Opportunity
Opportunities
Adds a Tag to an Opportunity
Adds a Tag to an Opportunity
Opportunities
Adds an Organisation
If you have trouble with creating an Organisation, try creating Organisations via the web interface, and then access those Organisations via the API. This way you can see examples of the fields and sub-elements attached to the Organisation. 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.
Organisations
Adds an Activity Set to an Organisation
Adds an Activity Set to an Organisation
Organisations
Adds a File Attachment to an Organisation
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. Some file types are not allowed for security reasons.
Organisations
Start following an Organisation
Start following an Organisation
Organisations
Adds a Link
Adds a Link
Organisations
Generates a new Merge Document
Returns the generated document. If the 'format' parameter is set to 'JSON', returns the metadata of the associated File Attachment in JSON format.
Organisations
Adds a Note to an Organisation
If you have trouble with creating an Organisation, try creating Organisations via the web interface, and then access those Organisations via the API. This way you can see examples of the fields and sub-elements attached to the Organisation. 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.
Organisations
Adds a Tag to an Organisation
Adds a Tag to an Organisation
Organisations
Adds a Price Book
If you have trouble with creating a Price Book, try creating Price Books via the web interface, and then access those Price Books via the API. This way you can see examples of the fields and sub-elements attached to the Price Book. 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.
PriceBooks
Start following a Price Book
Start following a Price Book
PriceBooks
Adds a Price Book Entry to a Price Book
Adds a Price Book Entry to a Price Book
PriceBooks
Adds a Product
If you have trouble with creating a Product, try creating Products via the web interface, and then access those Products via the API. This way you can see examples of the fields and sub-elements attached to the Product. 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.
Products
Start following a Product
Start following a Product
Products
Generates a new Merge Document
Returns the generated document. If the 'format' parameter is set to 'JSON', returns the metadata of the associated File Attachment in JSON format.
Products
Adds a Price Book Entry to a Product
Adds a Price Book Entry to a Product
Products
Adds a Project
If you have trouble with creating a Project, try creating Projects via the web interface, and then access those Projects via the API. This way you can see examples of the fields and sub-elements attached to the Project. 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.
Projects
Adds an Activity Set to a Project
Adds an Activity Set to a Project
Projects
Adds a File Attachment to a Project
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. Some file types are not allowed for security reasons.
Projects
Start following a Project
Start following a Project
Projects
Adds a Link
Adds a Link
Projects
Generates a new Merge Document
Returns the generated document. If the 'format' parameter is set to 'JSON', returns the metadata of the associated File Attachment in JSON format.
Projects
Adds a Note to a Project
If you have trouble with creating a Project, try creating Projects via the web interface, and then access those Projects via the API. This way you can see examples of the fields and sub-elements attached to the Project. 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.
Projects
Adds a Tag to a Project
Adds a Tag to a Project
Projects
Adds a Prospect
If you have trouble with creating a Prospect, try creating Prospects via the web interface, and then access those Prospects via the API. This way you can see examples of the fields and sub-elements attached to the Prospect. 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.
Prospects
Start following a Prospect
Start following a Prospect
Prospects
Adds a Tag to a Prospect
Adds a Tag to a Prospect
Prospects
Adds a Quote
If you have trouble with creating a Quote, try creating Quotes via the web interface, and then access those Quotes via the API. This way you can see examples of the fields and sub-elements attached to the Quote. 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.
Quotes
Start following a Quote
Start following a Quote
Quotes
Generates a new Merge Document
Returns the generated document. If the 'format' parameter is set to 'JSON', returns the metadata of the associated File Attachment in JSON format.
Quotes
Adds a Quote Product to a Quote
Adds a Quote Product to a Quote
Quotes
Adds a Task
If you have trouble with creating a Task, try creating Tasks via the web interface, and then access those Tasks via the API. This way you can see examples of the fields and sub-elements attached to the Task. 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.
Tasks
Adds a Comment to a Task
Adds a Comment to a Task
Tasks
Start following a Task
Start following a Task
Tasks
Adds a Link
Adds a Link
Tasks
Adds a Team Member
Adds a Team Member
Teams
Adds a Ticket
If you have trouble with creating a Ticket, try creating Tickets via the web interface, and then access those Tickets via the API. This way you can see examples of the fields and sub-elements attached to the Ticket. 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.
Tickets
Adds a Comment to a Ticket
Adds a Comment to a Ticket
Tickets
Start following a Ticket
Start following a Ticket
Tickets
Adds a Tag to a Ticket
Adds a Tag to a Ticket
Tickets
Updates a Comment
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.
Comments
Updates a Forum Comment
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.
ForumComments
Updates a Forum
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.
Forums
Updates a Forum Post
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.
ForumPosts
Updates a Forum Comment of a Forum Post
Updates a Forum Comment of a Forum Post
ForumPosts
Updates a Contact
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.
Contacts
Updates an Email's Tags
Updates an Email's Tags
Emails
Updates an Event
If you have trouble updating an Event, try accessing the Event 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.
Events
Updates an Event's Custom Image Field
This action will replace any existing Image attached to the Event'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.
Events
Updates a Knowledge Article
If you have trouble updating a Knowledge Article, try accessing the Knowledge Article 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.
KnowledgeArticles
Updates a Knowledge Article Category
If you have trouble updating a Knowledge Article Category, try accessing the Knowledge Article Category 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.
KnowledgeArticleCategories
Updates a Knowledge Article Folder
If you have trouble updating a Knowledge Article Folder, try accessing the Knowledge Article Folder 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.
KnowledgeArticleFolders
Updates a Knowledge Article's Custom Image Field
This action will replace any existing Image attached to the Knowledge Article'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.
KnowledgeArticles
Updates a Knowledge Article's Tags
Updates a Knowledge Article's Tags
KnowledgeArticles
Updates a Knowledge Article's translation in a specific language
If you have trouble updating a Knowledge Article, try accessing the Knowledge Article 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.
KnowledgeArticles
Updates a Lead
If you have trouble updating a Lead, try accessing the Lead 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.
Leads
Updates a Lead's Custom Image Field
This action will replace any existing Image attached to the Lead'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.
Leads
Updates a Lead's Image
This action will replace any existing Image attached to the Lead. 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.
Leads
Updates a note of a Lead
If you have trouble updating a Lead, try accessing the Lead 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.
Leads
Updates a Lead's Tags
Updates a Lead's Tags
Leads
Updates a Note
If you have trouble updating a Note, try accessing the Note 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.
Notes
Updates a Comment of a Note
Updates a Comment of a Note
Notes
Updates an Opportunity
If you have trouble updating an Opportunity, try accessing the Opportunity 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.
Opportunities
Updates an Opportunity's Custom Image Field
This action will replace any existing Image attached to the Opportunity'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.
Opportunities
Updates an Opportunity's Image
This action will replace any existing Image attached to the Opportunity. 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.
Opportunities
Updates a Link
Updates a Link
Opportunities
Updates a note of an Opportunity
If you have trouble updating an Opportunity, try accessing the Opportunity 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.
Opportunities
Updates an Opportunity Product of an Opportunity
Updates an Opportunity Product of an Opportunity
Opportunities
Updates an Opportunity's Tags
Updates an Opportunity's Tags
Opportunities
Updates an Opportunity Product's Custom Image Field
This action will replace any existing Image attached to the Opportunity Product'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.
OpportunityProducts
Updates an Organisation
If you have trouble updating an Organisation, try accessing the Organisation 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.
Organisations
Updates an Organisation's Dates
Updates an Organisation's Dates
Organisations
Updates an Organisation's Custom Image Field
This action will replace any existing Image attached to the Organisation'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.
Organisations
Updates an Organisation's Image
This action will replace any existing Image attached to the Organisation. 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.
Organisations
Updates a Link
Updates a Link
Organisations
Updates a note of an Organisation
If you have trouble updating an Organisation, try accessing the Organisation 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.
Organisations
Updates an Organisation's Tags
Updates an Organisation's Tags
Organisations
Updates a Price Book
If you have trouble updating a Price Book, try accessing the Price Book 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.
PriceBooks
Updates a Price Book Entry's Custom Image Field
This action will replace any existing Image attached to the Price Book Entry'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.
PriceBookEntries
Updates a Price Book Entry of a Price Book
Updates a Price Book Entry of a Price Book
PriceBooks
Updates a Product
If you have trouble updating a Product, try accessing the Product 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.
Products
Updates a Product's Custom Image Field
This action will replace any existing Image attached to the Product'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.
Products
Updates a Product's Image
This action will replace any existing Image attached to the Product. 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.
Products
Updates a Price Book Entry of a Product
Updates a Price Book Entry of a Product
Products
Updates a Project
If you have trouble updating a Project, try accessing the Project 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.
Projects
Updates a Project's Custom Image Field
This action will replace any existing Image attached to the Project'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.
Projects
Updates a Project's Image
This action will replace any existing Image attached to the Project. 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.
Projects
Updates a Link
Updates a Link
Projects
Updates a note of a Project
If you have trouble updating a Project, try accessing the Project 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.
Projects
Changes current pipeline for the Project
Changes current pipeline for the Project
Projects
Changes current pipeline stage for the Project
Changes current pipeline stage for the Project
Projects
Updates a Project's Tags
Updates a Project's Tags
Projects
Updates a Prospect
If you have trouble updating a Prospect, try accessing the Prospect 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.
Prospects
Updates a Prospect's Custom Image Field
This action will replace any existing Image attached to the Prospect'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.
Prospects
Updates a Prospect's Tags
Updates a Prospect's Tags
Prospects
Updates a Quote
If you have trouble updating a Quote, try accessing the Quote 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.
Quotes
Updates a Quote's Custom Image Field
This action will replace any existing Image attached to the Quote'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.
Quotes
Updates a Quote Product of a Quote
Updates a Quote Product of a Quote
Quotes
Updates a Quote Product's Custom Image Field
This action will replace any existing Image attached to the Quote Product'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.
QuoteProducts
Updates a Task
If you have trouble updating a Task, try accessing the Task 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.
Tasks
Updates a Task's Custom Image Field
This action will replace any existing Image attached to the Task'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.
Tasks
Updates a Ticket
If you have trouble updating a Ticket, try accessing the Ticket 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.
Tickets
Updates a Ticket's Custom Image Field
This action will replace any existing Image attached to the Ticket'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.
Tickets
Updates a Ticket's Tags
Updates a Ticket's Tags
Tickets
Sync Quote to an Opportunity
Syncs a quote to its associated opportunity. If the opportunity already has another quote synced to it, it will unsync that quote and then sync this new quote to the opportunity.
Quotes
Updates a Forum Post of a Forum
Updates a Forum Post of a Forum
Forums
Updates a Contact's Dates
Updates a Contact's Dates
Contacts
Updates an Organisation's Email Domains
Updates an Organisation's Email Domains
Organisations
Updates a record
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.
CustomObjectsRecords
Updates a File Category
This endpoint is used to update an existing File Category. This endpoint is only accessible to users with administrator permission.
FileCategories
Updates 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.
Contacts
Updates 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.
Contacts
Updates a Lead Source
This endpoint is used to update an existing lead source.
LeadSources
Updates a Lead Status
This endpoint is used to update an existing lead status. This endpoint is only accessible to users with administrator access.
LeadStatuses
Updates a Link
Updates a Link
Contacts
Updates a Milestone
Updates a Milestone
Projects
Updates a note of a Contact
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.
Contacts
Updates an Opportunity Category
This endpoint is used to update an existing opportunity category (for example, to change the background color for its label in the user interace). This endpoint is only accessible to users with administrator permission.
OpportunityCategories
Updates an Opportunity State
Updates an Opportunity State
Opportunities
Changes current pipeline for the Opportunity
Changes current pipeline for the Opportunity
Opportunities
Changes current pipeline stage for the Opportunity
Changes current pipeline stage for the Opportunity
Opportunities
Changes current Price Book for the Opportunity
Changes current Price Book for the Opportunity
Opportunities
Updates a Project Category
This endpoint is used to update an existing project category. This endpoint is only accessible to users with administrator permission.
ProjectCategories
Updates a Prospect's static list memberships
Updates a Prospect's static list memberships
Prospects
Updates a Contact's Tags
Updates a Contact's Tags
Contacts
Updates a Task Category
This endpoint is used to update an existing task category, for example to change the background color for the task category's label in the web UI. This endpoint is only accessible to users with administrator permission.
TaskCategories
Updates a Team
When updating Anonymous Teams, the brief parameter has no effect and you must include all the Team Members that should be part of the team. A minimum of one Team Member is required. For more details, please refer to GET /Teams above.
Teams
Updates a record's translation in a specific language
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.
CustomObjectsRecords
FAQ

Insightly integration, answered

How do AI agents use Insightly through Open Connector?
Your user connects Insightly once with one of its cataloged authentication methods. Open Connector stores the credential in an encrypted vault and exposes Insightly tools to your agent over MCP or a typed API, with credentials injected server-side on each call.
Is this a Insightly MCP server?
Yes. Open Connector can serve Insightly as a named MCP server with a scoped allowlist and a per-user connection URL, so any MCP client can call Insightly actions with credentials injected server-side.
Where do Insightly credentials live?
In your own infrastructure. Open Connector keeps credentials in its own vault and injects them at call time, so they never leave your environment.

Give your agents Insightly — keep the keys.

Open source, self-hostable, with Insightly credentials that never leave your infrastructure. Run it from source today.