Insightly

Insightly node reference - all 340 operations, the credential it needs, and a worked example.

Insightly CRM v3.1 REST API. 340 operations: full CRUD, search and tag search for contacts, organisations, opportunities, leads and projects, plus their notes, tasks, emails, events, tags, relationship links, file attachments, activity sets and important dates; opportunity pipelines, stages, states and line items; project pipelines and milestones; standalone tasks, events, notes, comments and stored emails; Service tickets with comments, tags and merge; marketing prospects, static lists, custom events and visits; products, price books, price book entries and quotes with line items and documents; custom objects and custom field metadata; the Service knowledge base and community forums; and the user, pipeline, tag, relationship, category, currency, country and template lookups.

Credential: Insightly apiKey|pod - see Credentials.

Permissions

Insightly has no scope system, no OAuth flow and no consent screen. Authentication is HTTP Basic with the API key as the USERNAME and a blank password, and the key simply IS a user: Insightly's own API help states that "permissions to view, edit, and delete records via the API are the same as that user's permissions on the Insightly web application". Its machine-readable v3.1 spec agrees - it publishes no securityDefinitions and attaches no per-operation security block to any of its 527 operations. So a 403 from Insightly is never a missing grant on the token; it means the Insightly USER the key belongs to cannot do that in the web app either, which is fixed under Settings > Permissions rather than by re-issuing the key. Limit the blast radius by issuing the key under a user with a restricted permission set. One thing the credential DOES gate is the region: the pod half of the apiKey|pod value picks the host, and a valid key sent to the wrong pod answers 401 rather than redirecting.

Operations (340)

Contacts

Operation	What it does
`listContacts`	List contacts
`getContact`	Get contact
`createContact`	Create contact
`updateContact`	Update contact
`deleteContact`	Delete contact
`searchContacts`	Search contacts
`searchContactsByTag`	Search contacts by tag

Organisations

Operation	What it does
`listOrganisations`	List organisations
`getOrganisation`	Get organisation
`createOrganisation`	Create organisation
`updateOrganisation`	Update organisation
`deleteOrganisation`	Delete organisation
`searchOrganisations`	Search organisations
`searchOrganisationsByTag`	Search organisations by tag

Opportunities

Operation	What it does
`listOpportunities`	List opportunities
`getOpportunity`	Get opportunity
`createOpportunity`	Create opportunity
`updateOpportunity`	Update opportunity
`deleteOpportunity`	Delete opportunity
`searchOpportunities`	Search opportunities
`searchOpportunitiesByTag`	Search opportunities by tag

Leads

Operation	What it does
`listLeads`	List leads
`getLead`	Get lead
`createLead`	Create lead
`updateLead`	Update lead
`deleteLead`	Delete lead
`searchLeads`	Search leads
`searchLeadsByTag`	Search leads by tag

Projects

Operation	What it does
`listProjects`	List projects
`getProject`	Get project
`createProject`	Create project
`updateProject`	Update project
`deleteProject`	Delete project
`searchProjects`	Search projects
`searchProjectsByTag`	Search projects by tag

Operation	What it does
`listContactNotes`	List contact notes
`addContactNote`	Add note to contact
`updateContactNote`	Update contact note
`listContactTasks`	List contact tasks
`listContactEmails`	List contact emails
`listContactEvents`	List contact events
`listContactFileAttachments`	List contact file attachments
`assignContactActivitySet`	Assign activity set to contact
`listContactTags`	List contact tags
`addContactTag`	Add tag to contact
`removeContactTag`	Remove tag from contact
`listContactLinks`	List contact links
`addContactLink`	Add link to contact
`updateContactLink`	Update contact link
`deleteContactLink`	Delete contact link
`getContactDates`	Get contact important dates
`updateContactDates`	Update contact important dates

Operation	What it does
`listOrganisationNotes`	List organisation notes
`addOrganisationNote`	Add note to organisation
`updateOrganisationNote`	Update organisation note
`listOrganisationTasks`	List organisation tasks
`listOrganisationEmails`	List organisation emails
`listOrganisationEvents`	List organisation events
`listOrganisationFileAttachments`	List organisation file attachments
`assignOrganisationActivitySet`	Assign activity set to organisation
`listOrganisationTags`	List organisation tags
`addOrganisationTag`	Add tag to organisation
`removeOrganisationTag`	Remove tag from organisation
`listOrganisationLinks`	List organisation links
`addOrganisationLink`	Add link to organisation
`updateOrganisationLink`	Update organisation link
`deleteOrganisationLink`	Delete organisation link
`getOrganisationDates`	Get organisation important dates
`updateOrganisationDates`	Update organisation important dates
`getOrganisationEmailDomains`	Get organisation email domains
`updateOrganisationEmailDomains`	Update organisation email domains

Operation	What it does
`listOpportunityNotes`	List opportunity notes
`addOpportunityNote`	Add note to opportunity
`updateOpportunityNote`	Update opportunity note
`listOpportunityTasks`	List opportunity tasks
`listOpportunityEmails`	List opportunity emails
`listOpportunityEvents`	List opportunity events
`listOpportunityFileAttachments`	List opportunity file attachments
`assignOpportunityActivitySet`	Assign activity set to opportunity
`listOpportunityTags`	List opportunity tags
`addOpportunityTag`	Add tag to opportunity
`removeOpportunityTag`	Remove tag from opportunity
`listOpportunityLinks`	List opportunity links
`addOpportunityLink`	Add link to opportunity
`updateOpportunityLink`	Update opportunity link
`deleteOpportunityLink`	Delete opportunity link
`getOpportunityLinkEmailAddress`	Get opportunity link email address

Operation	What it does
`listLeadNotes`	List lead notes
`addLeadNote`	Add note to lead
`updateLeadNote`	Update lead note
`listLeadTasks`	List lead tasks
`listLeadEmails`	List lead emails
`listLeadEvents`	List lead events
`listLeadFileAttachments`	List lead file attachments
`assignLeadActivitySet`	Assign activity set to lead
`listLeadTags`	List lead tags
`addLeadTag`	Add tag to lead
`removeLeadTag`	Remove tag from lead
`getLeadLinkEmailAddress`	Get lead link email address

Operation	What it does
`listProjectNotes`	List project notes
`addProjectNote`	Add note to project
`updateProjectNote`	Update project note
`listProjectTasks`	List project tasks
`listProjectEmails`	List project emails
`listProjectEvents`	List project events
`listProjectFileAttachments`	List project file attachments
`assignProjectActivitySet`	Assign activity set to project
`listProjectTags`	List project tags
`addProjectTag`	Add tag to project
`removeProjectTag`	Remove tag from project
`listProjectLinks`	List project links
`addProjectLink`	Add link to project
`updateProjectLink`	Update project link
`deleteProjectLink`	Delete project link
`getProjectLinkEmailAddress`	Get project link email address

Opportunity pipeline & products

Operation	What it does
`listOpportunityLineItems`	List opportunity products
`addOpportunityLineItem`	Add product to opportunity
`updateOpportunityLineItem`	Update opportunity product
`deleteOpportunityLineItem`	Delete opportunity product
`setOpportunityPipeline`	Set opportunity pipeline
`clearOpportunityPipeline`	Clear opportunity pipeline
`setOpportunityPipelineStage`	Set opportunity pipeline stage
`setOpportunityPricebook`	Set opportunity price book
`changeOpportunityState`	Change opportunity state (won / lost / abandoned)
`getOpportunityStateHistory`	Get opportunity state history

Project pipeline & milestones

Operation	What it does
`listProjectMilestones`	List project milestones
`addProjectMilestone`	Add project milestone
`updateProjectMilestone`	Update project milestone
`deleteProjectMilestone`	Delete project milestone
`setProjectPipeline`	Set project pipeline
`clearProjectPipeline`	Clear project pipeline
`setProjectPipelineStage`	Set project pipeline stage

Tasks

Operation	What it does
`listTasks`	List tasks
`getTask`	Get task
`createTask`	Create task
`updateTask`	Update task
`deleteTask`	Delete task
`searchTasks`	Search tasks
`listTaskComments`	List task comments
`addTaskComment`	Add comment to task
`listTaskLinks`	List task links
`addTaskLink`	Add link to task
`deleteTaskLink`	Delete task link

Events

Operation	What it does
`listEvents`	List events
`getEvent`	Get event
`createEvent`	Create event
`updateEvent`	Update event
`deleteEvent`	Delete event
`searchEvents`	Search events
`listEventLinks`	List event links
`addEventLink`	Add link to event
`deleteEventLink`	Delete event link

Notes & comments

Operation	What it does
`listNotes`	List notes
`getNote`	Get note
`updateNote`	Update note
`deleteNote`	Delete note
`searchNotes`	Search notes
`listNoteComments`	List note comments
`addNoteComment`	Add comment to note
`listNoteFileAttachments`	List note file attachments
`listNoteLinks`	List note links
`addNoteLink`	Add link to note
`deleteNoteLink`	Delete note link
`updateComment`	Update comment
`deleteComment`	Delete comment
`listCommentFileAttachments`	List comment file attachments

Emails

Operation	What it does
`listEmails`	List emails
`getEmail`	Get email
`deleteEmail`	Delete email
`searchEmails`	Search emails
`searchEmailsByTag`	Search emails by tag
`listEmailComments`	List email comments
`addEmailComment`	Add comment to email
`listEmailFileAttachments`	List email file attachments
`listEmailLinks`	List email links
`addEmailLink`	Add link to email
`deleteEmailLink`	Delete email link
`listEmailTags`	List email tags
`addEmailTag`	Add tag to email
`removeEmailTag`	Remove tag from email

Tickets (Service)

Operation	What it does
`listTickets`	List tickets
`getTicket`	Get ticket
`createTicket`	Create ticket
`updateTicket`	Update ticket
`deleteTicket`	Delete ticket
`searchTickets`	Search tickets
`searchTicketsByTag`	Search tickets by tag
`listTicketComments`	List ticket comments
`addTicketComment`	Add comment to ticket
`mergeTicket`	Merge ticket into another
`listTicketTags`	List ticket tags
`addTicketTag`	Add tag to ticket
`removeTicketTag`	Remove tag from ticket

Prospects (Marketing)

Operation	What it does
`listProspects`	List prospects
`getProspect`	Get prospect
`createProspect`	Create prospect
`updateProspect`	Update prospect
`deleteProspect`	Delete prospect
`searchProspects`	Search prospects
`searchProspectsByTag`	Search prospects by tag
`listProspectListMemberships`	List prospect static list memberships
`addProspectToList`	Add prospect to static list
`removeProspectFromList`	Remove prospect from static list
`listProspectTags`	List prospect tags
`addProspectTag`	Add tag to prospect
`removeProspectTag`	Remove tag from prospect
`createMarketingEvent`	Record marketing custom event
`listMarketingVisits`	List marketing visits
`listProspectMarketingVisits`	List marketing visits for a prospect

Products & price books

Operation	What it does
`listProducts`	List products
`getProduct`	Get product
`createProduct`	Create product
`updateProduct`	Update product
`deleteProduct`	Delete product
`searchProducts`	Search products
`listProductPricebookEntries`	List a product's price book entries
`addProductPricebookEntry`	Add price book entry to product
`updateProductPricebookEntry`	Update a product's price book entry
`deleteProductPricebookEntry`	Delete a product's price book entry
`listPricebooks`	List price books
`getPricebook`	Get price book
`createPricebook`	Create price book
`updatePricebook`	Update price book
`searchPricebooks`	Search price books
`listPricebookBookEntries`	List a price book's entries
`addPricebookEntry`	Add entry to price book
`updatePricebookEntry`	Update a price book's entry
`deletePricebookEntry`	Delete a price book's entry
`listPricebookEntries`	List all price book entries
`getPricebookEntry`	Get price book entry
`searchPricebookEntries`	Search price book entries

Quotes

Operation	What it does
`listQuotes`	List quotes
`getQuote`	Get quote
`createQuote`	Create quote
`updateQuote`	Update quote
`deleteQuote`	Delete quote
`searchQuotes`	Search quotes
`listQuoteLineItems`	List quote products
`addQuoteLineItem`	Add product to quote
`updateQuoteLineItem`	Update quote product
`deleteQuoteLineItem`	Delete quote product
`listQuoteDocuments`	List quote documents
`deleteQuoteDocument`	Delete quote document
`syncQuoteToOpportunity`	Sync quote to its opportunity
`listQuoteProducts`	List quote products (all quotes)
`getQuoteProduct`	Get quote product
`searchQuoteProducts`	Search quote products
`listOpportunityProducts`	List opportunity products (all opportunities)
`getOpportunityProduct`	Get opportunity product
`searchOpportunityProducts`	Search opportunity products

Custom objects

Operation	What it does
`listCustomObjectRecords`	List custom object records
`getCustomObjectRecord`	Get custom object record
`createCustomObjectRecord`	Create custom object record
`updateCustomObjectRecord`	Update custom object record
`deleteCustomObjectRecord`	Delete custom object record
`searchCustomObjectRecords`	Search custom object records
`listCustomObjectRecordFileAttachments`	List custom object record file attachments
`listCustomObjects`	List custom objects
`getCustomObject`	Get custom object
`listCustomFields`	List custom fields for an object
`getCustomField`	Get a custom field by name

Knowledge base (Service)

Operation	What it does
`listKnowledgeArticles`	List knowledge articles
`getKnowledgeArticle`	Get knowledge article
`createKnowledgeArticle`	Create knowledge article
`updateKnowledgeArticle`	Update knowledge article
`deleteKnowledgeArticle`	Delete knowledge article
`searchKnowledgeArticles`	Search knowledge articles
`searchKnowledgeArticlesByTag`	Search knowledge articles by tag
`listKnowledgeArticleTags`	List knowledge article tags
`addKnowledgeArticleTag`	Add tag to knowledge article
`removeKnowledgeArticleTag`	Remove tag from knowledge article
`listKnowledgeArticleCategories`	List knowledge article categories
`getKnowledgeArticleCategory`	Get knowledge article category
`createKnowledgeArticleCategory`	Create knowledge article category
`updateKnowledgeArticleCategory`	Update knowledge article category
`searchKnowledgeArticleCategories`	Search knowledge article categories
`listKnowledgeArticleFolders`	List knowledge article folders
`getKnowledgeArticleFolder`	Get knowledge article folder
`createKnowledgeArticleFolder`	Create knowledge article folder
`updateKnowledgeArticleFolder`	Update knowledge article folder
`searchKnowledgeArticleFolders`	Search knowledge article folders

Community forums (Service)

Operation	What it does
`listForums`	List forums
`getForum`	Get forum
`createForum`	Create forum
`updateForum`	Update forum
`searchForums`	Search forums
`listForumPostsInForum`	List posts in a forum
`addForumPostToForum`	Add post to a forum
`updateForumPostInForum`	Update a forum's post
`deleteForumPostInForum`	Delete a forum's post
`listForumPosts`	List forum posts
`getForumPost`	Get forum post
`createForumPost`	Create forum post
`updateForumPost`	Update forum post
`searchForumPosts`	Search forum posts
`listForumPostComments`	List comments on a forum post
`addForumPostComment`	Add comment to a forum post
`updateForumPostComment`	Update a forum post's comment
`deleteForumPostComment`	Delete a forum post's comment
`listForumComments`	List forum comments
`getForumComment`	Get forum comment
`createForumComment`	Create forum comment
`updateForumComment`	Update forum comment
`searchForumComments`	Search forum comments
`listForumCategories`	List forum categories
`getForumCategory`	Get forum category
`searchForumCategories`	Search forum categories

Users, config & lookups

Operation	What it does
`listUsers`	List users
`getUser`	Get user
`getCurrentUser`	Get the calling user
`searchUsers`	Search users
`getPermissions`	Get the calling user's permissions
`getInstance`	Get the Insightly instance
`listPipelines`	List pipelines
`getPipeline`	Get pipeline
`listPipelineStages`	List pipeline stages
`getPipelineStage`	Get pipeline stage
`listTags`	List tags used by a record type
`listRelationships`	List relationships
`listCountries`	List countries
`listCurrencies`	List currencies
`listLeadSources`	List lead sources
`listLeadStatuses`	List lead statuses
`listOpportunityStateReasons`	List opportunity state reasons
`listOpportunityCategories`	List opportunity categories
`getOpportunityCategory`	Get opportunity category
`listProjectCategories`	List project categories
`getProjectCategory`	Get project category
`listTaskCategories`	List task categories
`getTaskCategory`	Get task category
`listFileCategories`	List file categories
`getFileCategory`	Get file category
`listActivitySets`	List activity sets
`getActivitySet`	Get activity set
`listDocumentTemplates`	List document templates
`getDocumentTemplate`	Get document template
`searchDocumentTemplates`	Search document templates
`listMilestones`	List milestones
`getMilestone`	Get milestone
`searchMilestones`	Search milestones

Example

Update a contact without a record id in the path

Insightly's update endpoints take no id in the URL — PUT /Contacts addresses the record by CONTACT_ID inside the BODY, and there is no PUT /Contacts/{id} at all. The node hides that: you fill in Record ID as you would anywhere else and the dispatcher injects it into the body under the right key, so one input means the same thing across all 21 update operations.

Set Operation to updateContact, then fill in:

Field	Value	Notes
`recordId`	`{{ myTrigger.contactId }}`	Goes into the BODY, not the path — Insightly has no `PUT /Contacts/{id}`
`fieldValuesJson`	`{"PHONE": "{{ myTrigger.phone }}", "TAGS": [{"TAG_NAME": "renewed"}]}`	Insightly types every write body as an untyped bag: standard fields plus CUSTOMFIELDS[], TAGS[], LINKS[] and DATES[]

Sets {{contact.id}} and {{contact.contact}} (the full updated record). A valid key sent to the wrong regional pod answers 401, not a redirect, which is why the node's 401 message names both halves of the credential.

On this page