Insightly

Adds an Activity Set to a Contact

Adds a Forum Post to a Forum

Adds a Comment to an Email

This endpoint loads Insightly object page within the client browser running Insightly for convenience and increased productivity.

AddDisplayTicketOnClient

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.

PROSPECT_ID, CATEGORY, and ACTION are all required when creating an event. These are used to properly categorize and score the event.

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.

This endpoint is used to create a new File Category. This endpoint is only accessible to users with administrator permission.

Start following a Forum Comment

This endpoint is used to define a new lead source. This endpoint is only accessible to users with administrator access.

This endpoint is used to add a new lead status option to the instance. This endpoint is only accessible to users with administrator access.

Adds a Link

Merges the Ticket into another Ticket

Adds a Milestone

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.

This endpoint is used to create a new opportunity category. This endpoint is only accessible to users with administrator permission.

This endpoint is used to create a new project category. This endpoint is only accessible to users with administrator permission.

Adds a Prospect to a static list

Adds a Tag to a Contact

This endpoint is used to create a new task category. This endpoint is only accessible to users with administrator permission.

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.

Note: Team Members of Anonymous Teams can only be created via the /Teams endpoint.

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.

Deletes a Forum Post of a Forum

Deletes a Record

Deletes a File Attachment

This endpoint is used to deactivate an existing File Category. This endpoint is only accessible to users with administrator permission.

Stop following a Forum Comment

Deletes a Contact's Image

Deletes a Contact's Custom Image Field

This endpoint is used to delete an existing lead source.

This endpoint is used to delete an existing lead status.

Deletes a Link

Deletes a Milestone

The endpoint is used to deactivate an existing opportunity category. This endpoint is only accessible to users with administrator permission.

Clears pipeline for the Opportunity

This endpoint is used to deactivate an existing project category. This endpoint is only accessible to users with administrator permission.

Removes a Prospect from a static list

Deletes a Tag from a Contact

This endpoint is used to deactivate a task category. This endpoint is only accessible to users with administrator permission.

Deletes a Team

Note: Team Members of Anonymous Teams can only be deleted via the /Teams endpoint.

Deletes a Comment

Stop following a Forum

Deletes a Forum Comment of a Forum Post

Stop following a Forum Post

Deletes a Contact

Stop following a Contact

Deletes an Email

Stop following an Email

Deletes a Link

Deletes a Tag from an Email

Deletes an Event

Deletes an Event's Custom Image Field

Deletes a Link

Stop following a Forum Category

Deletes a Knowledge Article

Stop following a Knowledge Article

Deletes a Knowledge Article's Custom Image Field

Deletes a Tag from a Knowledge Article

Deletes a Lead

Stop following a Lead

Deletes a Lead's Image

Deletes a Lead's Custom Image Field

Deletes a Tag from a Lead

Deletes a Note

Deletes a Comment of a Note

Stop following a Note

Deletes a Link

Deletes an Opportunity

Stop following an Opportunity

Deletes an Opportunity's Image

Deletes an Opportunity's Custom Image Field

Deletes a Link

Deletes an Opportunity Product of an Opportunity

Deletes a Tag from an Opportunity

Deletes an Opportunity Product's Custom Image Field

Deletes an Organisation

Stop following an Organisation

Deletes an Organisation's Image

Deletes an Organisation's Custom Image Field

Deletes a Link

Deletes a Tag from an Organisation

Deletes a Price Book Entry's Custom Image Field

Stop following a Price Book

Deletes a Price Book Entry of a Price Book

Deletes a Product

Stop following a Product

Deletes a Product's Image

Deletes a Product's Custom Image Field

Deletes a Price Book Entry of a Product

Deletes a Project

Stop following a Project

Deletes a Project's Image

Deletes a Project's Custom Image Field

Deletes a Link

Clears pipeline for the Project

Deletes a Tag from a Project

Deletes a Prospect

Stop following a Prospect

Deletes a Prospect's Custom Image Field

Deletes a Tag from a Prospect

Deletes a Quote

Stop following a Quote

Deletes a Quote's Custom Image Field

Deletes a Quote Document of a Quote

Deletes a Quote Product of a Quote

Deletes a Quote Product's Custom Image Field

Deletes a Task

Stop following a Task

Deletes a Task's Custom Image Field

Deletes a Link

Deletes a Team Member

Deletes a Ticket

Stop following a Ticket

Deletes a Ticket's Custom Image Field

Deletes a Tag from a Ticket

Returns the generated document. If the 'format' parameter is set to 'JSON', returns the metadata of the associated File Attachment in JSON format.

Gets a single Activity Set

Gets a list of Activity Sets

Gets a list of Forum Posts of a Forum

Gets an Email's Comments

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

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

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

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

This read only endpoint returns a custom field by name.

Gets a Contact's Dates

Gets an Organisation's Email Domains

Gets a list of a Contact's Emails

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

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.

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

Gets a record

Gets a Contact's Events

Returns the requested File Attachment. If the 'format' parameter is set to 'JSON', returns the metadata of the File Attachment in JSON format.

Gets a Record's File Attachments

This read only endpoint returns a list of file categories that have been set up for the Insightly instance.

This endpoint returns the graph for a specific file category.

Gets a Follow state for a Forum Comment

Gets a list of followed records for the user

Gets a Contact's Image

Gets a Contact's Custom Image Field

Gets the Instance

This endpoint returns a list of the lead sources that have been defined on the Insightly instance.

This endpoint returns a list of the possible lead statuses that have been defined for the Insightly instance.

An email address to use as a mail drop for the Lead.

Gets a Contact's Links

Gets a list of Marketing Visits

Gets a list of Marketing Visits by prospect

Gets a list of a Project's Milestones

Gets a Contact's Notes

This read only endpoint returns a list of opportunity categories set up for the Insightly instance.

This endpoint returns the graph for a specific opportunity category

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.

Permissions determine if an individual user can read, edit, delete, or create records of a given object type.

This endpoint returns the graph for a specific pipeline.

This endpoint returns the graph for a specific pipeline stage.

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.

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).

This read only endpoint returns a list of the project categories that have been configured for the Insightly instance.

This endpoint is used to retrieve the graph for a specific project category.

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.

Gets the history of States and Reasons for an Opportunity.

Gets a Prospect's static list memberships

Gets a Contact's Tags

This read only endpoint returns a list of the task categories set up for the Insightly instance.

This endpoint returns the graph for a specific task category.

Gets a list of a Contact's Tasks

Gets a Team

Gets a Team Member

Gets a list of Team Members

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.

Gets a record's translation in a specific language

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.

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.

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).

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.

Gets a Comment's File Attachments

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

Gets a Forum Comment

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.

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

Gets a Forum

Gets a Follow state for a Forum

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.

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

Gets a Forum Post

Gets a list of Forum Comments of a Forum Post

Gets a Follow state for a Forum Post

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.

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

Gets a Contact

Gets a Contact's File Attachments

Gets a Follow state for a Contact

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.

This read only endpoint returns a custom object by name.

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

Gets a Document Template

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.

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

Gets an Email

Gets an Email's File Attachments

Gets a Follow state for an Email

Gets an Email's Links

Gets an Email's Tags

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.

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

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

Gets an Event

Gets an Event's Custom Image Field

Gets an Event's Links

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.

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

Gets a Forum Category

Gets a Follow state for a Forum Category

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.

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

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

Gets a Knowledge Article Category

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.

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

Gets a Knowledge Article Folder

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

Gets a Knowledge Article

Gets a Follow state for a Knowledge Article

Gets a Knowledge Article's Custom Image Field

Gets a Knowledge Article's Tags

Gets a Knowledge Article's translation in a specific language

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

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

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

Gets a Lead

Gets a list of a Lead's Emails

Gets a Lead's Events

Gets a Lead's File Attachments

Gets a Follow state for a Lead

Gets a Lead's Image

Gets a Lead's Custom Image Field

Gets a Lead's Notes

Gets a Lead's Tags

Gets a list of a Lead's 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.

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

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

Gets a Milestone

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.

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

Gets a Note

Gets a list of Comments of a Note

Gets a Note's Comments

Gets a Note's File Attachments

Gets a Follow state for a Note

Gets a Note's Links

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.

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

Gets an Opportunity

Gets a list of an Opportunity's Emails

Gets an Opportunity's Events

Gets an Opportunity's File Attachments

Gets a Follow state for an Opportunity

Gets an Opportunity's Image

Gets an Opportunity's Custom Image Field

An email address to use as a mail drop for the Opportunity.

Gets an Opportunity's Links

Gets an Opportunity's Notes

Gets a list of Opportunity Products of an Opportunity

Gets an Opportunity's Tags

Gets a list of an Opportunity's 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.

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

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

Gets an Opportunity Product

Gets an Opportunity Product's Custom Image Field

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.

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

Gets an Organisation

Gets an Organisation's Dates

Gets a list of an Organisation's Emails

Gets an Organisation's Events

Gets an Organisation's File Attachments

Gets a Follow state for an Organisation

Gets an Organisation's Image

Gets an Organisation's Custom Image Field

Gets an Organisation's Links

Gets an Organisation's Notes

Gets an Organisation's Tags

Gets a list of an Organisation's 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.

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

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

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

Gets a Price Book Entry

Gets a Price Book Entry's Custom Image Field

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

Gets a Price Book

Gets a Follow state for a Price Book

Gets a list of Price Book Entries of a Price Book

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.

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

Gets a Product

Gets a Follow state for a Product

Gets a Product's Image

Gets a Product's Custom Image Field

Gets a list of Price Book Entries of a Product

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.

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

Gets a Project

Gets a list of a Project's Emails

Gets a Project's Events

Gets a Project's File Attachments

Gets a Follow state for a Project

Gets a Project's Image

Gets a Project's Custom Image Field

An email address to use as a mail drop for the Project.

Gets a Project's Links

Gets a Project's Notes

Gets a Project's Tags

Gets a list of a Project's 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.

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

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

Gets a Prospect

Gets a Follow state for a Prospect

Gets a Prospect's Custom Image Field

Gets a Prospect's Tags

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.

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

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

Gets a Quote

Gets a Follow state for a Quote

Gets a Quote's Custom Image Field

Gets a list of Quote Documents of a Quote

Gets a list of Quote Products of a Quote

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

Gets a Quote Product

Gets a Quote Product's Custom Image Field

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.

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.

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

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

Gets a Task

Gets a Task's Comments

Gets a Follow state for a Task

Gets a Task's Custom Image Field

Gets a Task's Links

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.

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

Gets a Ticket

Gets a Ticket's Comments

Gets a Follow state for a Ticket

Gets a Ticket's Custom Image Field

Gets a Ticket's Tags

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.

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

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.

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.

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.