insightly_get_current_user
Get the current user
Fetch the user the API key belongs to (USER_ID, name, email, admin flag). A cheap way to confirm the key and pod are right, and to get your own id for owner fields. Insightly: GET /Users/Me.
Takes no parameters.
insightly_list_users
List users
List the users in the Insightly instance — needed to resolve OWNER_USER_ID / RESPONSIBLE_USER_ID. Insightly: GET /Users.
Parameterstopskipcount_total
insightly_list_records
List or search records
List records of one type — Contacts, Organisations, Leads, Opportunities, Projects, Tasks, Events or Notes — optionally filtered by one field value and/or last-updated time. With field_name + field_value (both required together) or updated_after_utc this uses GET /<Object>/Search; otherwise GET /<Object>. Field names are Insightly's UPPER_SNAKE names, e.g. EMAIL_ADDRESS, LAST_NAME, ORGANISATION_NAME, OPPORTUNITY_STATE, LEAD_RATING, or a custom field such as Industry__c.
Parameterstopskipbriefobjectrequiredfield_namecount_totalfield_valueupdated_after_utc
insightly_get_record
Get one record
Fetch a single Contact, Organisation, Lead, Opportunity, Project, Task, Event or Note by id, with its custom fields, tags and links. Insightly: GET /<Object>/{id}.
Parametersidrequiredobjectrequired
insightly_list_record_activity
List a record's notes, tasks or events
List the Notes, Tasks or Events attached to one Contact, Organisation, Lead, Opportunity or Project — the activity history of that record. Insightly: GET /<Object>/{id}/Notes | Tasks | Events.
Parametersidrequiredtopkindrequiredskipbriefobjectrequiredcount_totalupdated_after_utc
insightly_search_by_tag
Find records by tag
List Contacts, Organisations, Leads, Opportunities or Projects carrying a tag. Insightly: GET /<Object>/SearchByTag?tagName=.
Parameterstagrequiredtopskipbriefobjectrequiredcount_total
insightly_list_pipelines
List pipelines
List the sales and project pipelines (PIPELINE_ID, name, whether for opportunities or projects). Insightly: GET /Pipelines.
Parameterstopskip
insightly_list_pipeline_stages
List pipeline stages
List every pipeline stage (STAGE_ID, PIPELINE_ID, name, order) — map an opportunity's or project's STAGE_ID to a stage name. Insightly: GET /PipelineStages.
Parameterstopskip
insightly_list_lead_statuses
List lead statuses
List the lead statuses defined in the instance (LEAD_STATUS_ID, name, type). Insightly: GET /LeadStatuses.
Parameterstopskipinclude_converted
insightly_list_lead_sources
List lead sources
List the lead sources defined in the instance (LEAD_SOURCE_ID, name). Insightly: GET /LeadSources.
Parameterstopskip
insightly_create_contact
Create a contact
Create a contact (first_name is required). Insightly: POST /Contacts.
Parametersphonetitlelast_namebackgroundfirst_namerequiredsalutationphone_mobilecustom_fieldsemail_addressowner_user_idemail_opted_outorganisation_id+6 more
insightly_update_contact
Update a contact
Update a contact. Only the fields you pass are changed (v3.1 partial update). Insightly: PUT /Contacts with CONTACT_ID.
Parametersphonetitlelast_namebackgroundcontact_idrequiredfirst_namesalutationphone_mobilecustom_fieldsemail_addressowner_user_idemail_opted_out+7 more
insightly_create_organisation
Create an organisation
Create an organisation (company). Insightly: POST /Organisations.
Parametersphonewebsitebackgroundcustom_fieldsowner_user_idsocial_linkedinorganisation_namerequiredaddress_billing_cityaddress_billing_stateaddress_billing_streetaddress_billing_countryaddress_billing_postcode
insightly_update_organisation
Update an organisation
Update an organisation. Only the fields you pass are changed. Insightly: PUT /Organisations with ORGANISATION_ID.
Parametersphonewebsitebackgroundcustom_fieldsowner_user_idorganisation_idrequiredsocial_linkedinorganisation_nameaddress_billing_cityaddress_billing_stateaddress_billing_streetaddress_billing_country+1 more
insightly_create_lead
Create a lead
Create a lead (last_name is required). Insightly's schema also marks lead_status_id and lead_source_id as required — get valid ids from insightly_list_lead_statuses / insightly_list_lead_sources. Insightly: POST /Leads.
Parametersemailphonetitlemobilewebsiteindustrylast_namerequiredfirst_namesalutationlead_ratingaddress_cityaddress_state+12 more
insightly_update_lead
Update a lead
Update a lead. Only the fields you pass are changed. Insightly: PUT /Leads with LEAD_ID.
Parametersemailphonetitlemobilelead_idrequiredwebsiteindustrylast_namefirst_namesalutationlead_ratingaddress_city+13 more
insightly_create_opportunity
Create an opportunity
Create a sales opportunity (opportunity_name is required). Insightly: POST /Opportunities.
Parametersbid_typebid_amountcategory_idprobabilitybid_currencybid_durationcustom_fieldsowner_user_idorganisation_idopportunity_namerequiredforecast_close_dateopportunity_details+1 more
insightly_update_opportunity
Update an opportunity
Update an opportunity's value, probability, dates, owner or details. Only the fields you pass are changed. Insightly: PUT /Opportunities with OPPORTUNITY_ID.
Parametersbid_typebid_amountcategory_idprobabilitybid_currencybid_durationcustom_fieldsowner_user_idopportunity_idrequiredorganisation_idopportunity_nameforecast_close_date+2 more
insightly_create_task
Create a task
Create a task (title is required). Insightly requires OWNER_USER_ID and COMPLETED on a task: if owner_user_id is omitted it is filled with the API key's own user (via GET /Users/Me), and completed defaults to false. Insightly: POST /Tasks.
Parameterstitlerequiredstatusdetailsdue_dateprioritycompletedproject_idstart_datecategory_idcustom_fieldsowner_user_idopportunity_id+2 more
insightly_update_task
Update a task
Update a task — mark it completed, change due date, status, assignee or details. Only the fields you pass are changed. Insightly: PUT /Tasks with TASK_ID.
Parameterstitlestatusdetailstask_idrequireddue_dateprioritycompletedproject_idstart_datecategory_idcustom_fieldsowner_user_id+3 more
insightly_add_note
Add a note to a record
Add a note (title + body) to a Contact, Organisation, Lead, Opportunity or Project. Insightly: POST /<Object>/{id}/Notes.
Parametersidrequiredbodytitlerequiredobjectrequired