Connectors Reference

Insightly

Insightly is the easiest customer relationship management solution (CRM) to use for managing deep customer relationships. Customers use Insightly's tightly integrated CRM & project management features to close new business, track post sale customer interactions & drive repeat purchases.

 

Status: Preview

Tier: Standard

Version: 1.0

 

Actions:

Name

Summary

ListTasks ()

List tasks

UpdateTask (string id, TaskRequest updatedTask)

Update task

AddTask (TaskRequest newTask)

Add task

ListProjects ()

List projects

UpdateProject (string id, ProjectRequest updatedProject)

Update project

AddProject (ProjectRequest newProject)

Add project

ListLeads ()

List leads

UpdateLead (string id, LeadRequest updatedLead)

Update lead

AddLead (LeadRequest newLead)

Add lead

ListContacts ()

List contacts

UpdateContact (string id, ContactRequest updatedContact)

Update contact

AddContact (ContactRequest newContact)

Add contact

ListUsers ()

List users

DeleteTask (integer taskId)

Delete task

FollowTask (integer taskId)

Follow a task

DeleteProject (integer projectId)

Delete project

DeleteLead (integer leadId)

Delete lead

DeleteContact (integer contactId)

Delete contact

AddOrganization (OrganizationRequest newOrganization)

Add organization

 

Triggers:

Name

Summary

OnTaskAssignedToMe ()

When a task is assigned to me

OnTaskCreated ()

When a task is created

OnTaskUpdated ()

When a task is updated

OnProjectCreated ()

When a project is created

OnProjectUpdated ()

When a project is updated

OnLeadCreated ()

When a lead is created

OnLeadUpdated ()

When a lead is updated

OnContactCreated ()

When a contact is created

OnContactUpdated ()

When a contact is updated

OnEventCreated ()

When an event is created

OnEventUpdated ()

When an event is updated

 

Objects:

Name

Summary

Address

 

Contact

 

ContactInfo

 

ContactRequest

 

Event

 

Lead

 

LeadRequest

 

ListContactsResponse

 

ListEventsResponse

 

ListLeadsResponse

 

ListProjectsResponse

 

ListTasksResponse

 

ListUsersResponse

 

Object

 

Organization

 

OrganizationRequest

 

Project

 

ProjectRequest

 

Tag

 

Task

 

TaskRequest

 

User

 

 

Actions:

ListTasks

Summary: List tasks

Description: List tasks

 

Syntax:

Insightly.ListTasks ()

 

Returns:

          Type:ListTasksResponse

          Description: An Insightly Tasks response object.

 

UpdateTask

Summary: Update task

Description: Update task

 

Syntax:

Insightly.UpdateTask (string id, TaskRequest updatedTask)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Task Id)

Unique Id of the task to update.

True

ListTasks

updatedTask

TaskRequest

 

An Insightly Task Request Object

True

 

Returns:

          Type:Task

          Description: An Insightly Task Object

 

AddTask

Summary: Add task

Description: Add task

 

Syntax:

Insightly.AddTask (TaskRequest newTask)

 

Parameters:

Name

Type

Summary

Required

Related Action

newTask

TaskRequest

 

An Insightly Task Request Object

True

 

Returns:

          Type:Task

          Description: An Insightly Task Object

 

ListProjects

Summary: List projects

Description: List projects

 

Syntax:

Insightly.ListProjects ()

 

Returns:

          Type:ListProjectsResponse

          Description: A Insightly Project response object

 

UpdateProject

Summary: Update project

Description: Update project

 

Syntax:

Insightly.UpdateProject (string id, ProjectRequest updatedProject)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Project Id)

Unique Id of the project to update

True

ListProjects

updatedProject

ProjectRequest

 

An Insightly Project Object

True

 

Returns:

          Type:Project

          Description: An Insightly Project Object

 

AddProject

Summary: Add project

Description: Add project

 

Syntax:

Insightly.AddProject (ProjectRequest newProject)

 

Parameters:

Name

Type

Summary

Required

Related Action

newProject

ProjectRequest

 

An Insightly Project Object

True

 

Returns:

          Type:Project

          Description: An Insightly Project Object

 

ListLeads

Summary: List leads

Description: List leads

 

Syntax:

Insightly.ListLeads ()

 

Returns:

          Type:ListLeadsResponse

          Description: A Insightly Lead response object

 

UpdateLead

Summary: Update lead

Description: Update lead

 

Syntax:

Insightly.UpdateLead (string id, LeadRequest updatedLead)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Lead Id)

Unique Id of the lead to update

True

ListLeads

updatedLead

LeadRequest

 

An Insightly LeadRequest Object

True

 

Returns:

          Type:Lead

          Description: An Insightly Lead Object

 

AddLead

Summary: Add lead

Description: Add lead

 

Syntax:

Insightly.AddLead (LeadRequest newLead)

 

Parameters:

Name

Type

Summary

Required

Related Action

newLead

LeadRequest

 

An Insightly LeadRequest Object

True

 

Returns:

          Type:Lead

          Description: An Insightly Lead Object

 

ListContacts

Summary: List contacts

Description: List contacts

 

Syntax:

Insightly.ListContacts ()

 

Returns:

          Type:ListContactsResponse

          Description: A Insightly contact response object

 

UpdateContact

Summary: Update contact

Description: Update contact

 

Syntax:

Insightly.UpdateContact (string id, ContactRequest updatedContact)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Contact Id)

Unique Id of the contact to update

True

ListContacts

updatedContact

ContactRequest

 

An Insightly Contact Request Object

True

 

Returns:

          Type:Contact

          Description: An Insightly Contact Object

 

AddContact

Summary: Add contact

Description: Add contact

 

Syntax:

Insightly.AddContact (ContactRequest newContact)

 

Parameters:

Name

Type

Summary

Required

Related Action

newContact

ContactRequest

 

An Insightly Contact Request Object

True

 

Returns:

          Type:Contact

          Description: An Insightly Contact Object

 

ListUsers

Summary: List users

Description: List users

 

Syntax:

Insightly.ListUsers ()

 

Returns:

          Type:ListUsersResponse

          Description: A Insightly User response object

 

DeleteTask

Summary: Delete task

Description: Delete task

 

Syntax:

Insightly.DeleteTask (integer taskId)

 

Parameters:

Name

Type

Summary

Required

Related Action

taskId

integer(int32)

(Task Id)

Task Id

True

ListTasks

 

Returns:

          Type:Object

 

FollowTask

Summary: Follow a task

Description: Follow a task

 

Syntax:

Insightly.FollowTask (integer taskId)

 

Parameters:

Name

Type

Summary

Required

Related Action

taskId

integer(int32)

(Task Id)

Task Id

True

 

Returns:

          Type:Object

 

DeleteProject

Summary: Delete project

Description: Delete project

 

Syntax:

Insightly.DeleteProject (integer projectId)

 

Parameters:

Name

Type

Summary

Required

Related Action

projectId

integer(int32)

(Project Id)

Project Id

True

ListProjects

 

Returns:

          Type:Object

 

DeleteLead

Summary: Delete lead

Description: Delete lead

 

Syntax:

Insightly.DeleteLead (integer leadId)

 

Parameters:

Name

Type

Summary

Required

Related Action

leadId

integer(int32)

(Lead Id)

Lead Id

True

ListLeads

 

Returns:

          Type:Object

 

DeleteContact

Summary: Delete contact

Description: Delete contact

 

Syntax:

Insightly.DeleteContact (integer contactId)

 

Parameters:

Name

Type

Summary

Required

Related Action

contactId

integer(int32)

(Contact Id)

Contact Id

True

ListContacts

 

Returns:

          Type:Object

 

AddOrganization

Summary: Add organization

Description: Add organization

 

Syntax:

Insightly.AddOrganization (OrganizationRequest newOrganization)

 

Parameters:

Name

Type

Summary

Required

Related Action

newOrganization

OrganizationRequest

 

An Insightly Organization Request Object

True

 

Returns:

          Type:Organization

          Description: An Insightly Organization Object

 

Triggers:

Trigger OnTaskAssignedToMe

Summary: When a task is assigned to me

Description: Triggers a new flow when a task is assigned to me

 

Syntax:

Insightly.OnTaskAssignedToMe ()

 

Returns:

          Type:ListTasksResponse

          Description: An Insightly Tasks response object.

 

Trigger OnTaskCreated

Summary: When a task is created

Description: Triggers a new flow when a new task is created

 

Syntax:

Insightly.OnTaskCreated ()

 

Returns:

          Type:ListTasksResponse

          Description: An Insightly Tasks response object.

 

Trigger OnTaskUpdated

Summary: When a task is updated

Description: Triggers a new flow when a task is updated

 

Syntax:

Insightly.OnTaskUpdated ()

 

Returns:

          Type:ListTasksResponse

          Description: An Insightly Tasks response object.

 

Trigger OnProjectCreated

Summary: When a project is created

Description: Triggers a new flow when a new project is created

 

Syntax:

Insightly.OnProjectCreated ()

 

Returns:

          Type:ListProjectsResponse

          Description: A Insightly Project response object

 

Trigger OnProjectUpdated

Summary: When a project is updated

Description: Triggers a new flow when a project is updated

 

Syntax:

Insightly.OnProjectUpdated ()

 

Returns:

          Type:ListProjectsResponse

          Description: A Insightly Project response object

 

Trigger OnLeadCreated

Summary: When a lead is created

Description: Triggers a new flow when a new lead is created

 

Syntax:

Insightly.OnLeadCreated ()

 

Returns:

          Type:Lead

          Description: An Insightly Lead Object

 

Trigger OnLeadUpdated

Summary: When a lead is updated

Description: Triggers a new flow when a lead is updated

 

Syntax:

Insightly.OnLeadUpdated ()

 

Returns:

          Type:Lead

          Description: An Insightly Lead Object

 

Trigger OnContactCreated

Summary: When a contact is created

Description: Triggers a new flow when a new contact is created

 

Syntax:

Insightly.OnContactCreated ()

 

Returns:

          Type:ListContactsResponse

          Description: A Insightly contact response object

 

Trigger OnContactUpdated

Summary: When a contact is updated

Description: Triggers a new flow when a contact is updated

 

Syntax:

Insightly.OnContactUpdated ()

 

Returns:

          Type:ListContactsResponse

          Description: A Insightly contact response object

 

Trigger OnEventCreated

Summary: When an event is created

Description: Triggers a new flow when a new event is created

 

Syntax:

Insightly.OnEventCreated ()

 

Returns:

          Type:ListEventsResponse

          Description: A Insightly Event response object

 

Trigger OnEventUpdated

Summary: When an event is updated

Description: Triggers a new flow when an event is updated

 

Syntax:

Insightly.OnEventUpdated ()

 

Returns:

          Type:ListEventsResponse

          Description: A Insightly Event response object

 


 

Address

Summary:

Description: An Insightly Contact Address Object

 

          Properties:

Name

Type

Summary

ADDRESS_ID

integer(int32)

Address Id

The unique identifier of the address.

ADDRESS_TYPE

string

Address Type

Address type.

STREET

string

Address Street

Address street.

CITY

string

Address City

Address city.

STATE

string

Address State

Address state.

POSTCODE

string

Address Postcode

Address postcode.

COUNTRY

string

Address Country

Address country.


 

Contact

Summary:

Description: An Insightly Contact Object

 

          Properties:

Name

Type

Summary

ADDRESS_WORK

ADDRESS_WORK

Address (Work)

 

ADDRESS_HOME

ADDRESS_HOME

Address (Home)

 

ADDRESS_POSTAL

ADDRESS_POSTAL

Address (Postal)

 

ADDRESS_PRIMARY

ADDRESS_PRIMARY

Address (Primary)

 

ADDRESS_OTHER

ADDRESS_OTHER

Address (Other)

 

EMAIL_WORK

string

Email (Work)

The work email of the contact.

EMAIL_HOME

string

Email (Home)

The home email of the contact.

EMAIL_PERSONAL

string

Email (Personal)

The personal email of the contact.

EMAIL_OTHER

string

Email (Other)

The other email of the contact.

PHONE_WORK

string

Phone (Work)

The work phone number of the contact.

PHONE_HOME

string

Phone (Home)

The home phone number of the contact.

PHONE_MOBILE

string

Phone (mobile)

The mobile phone number of the contact.

PHONE_OTHER

string

Phone (Other)

The other phone number of the contact.

CONTACT_ID

integer(int32)

Contact Id

The unique identifier of the contact.

SALUTATION

string

Salutation

The salutation of the contact.

FIRST_NAME

string

First Name

First name of the contact.

LAST_NAME

string

Last Name

Last name of the contact.

IMAGE_URL

string

Image URL

Contact image URL.

DATE_CREATED_UTC

string

Created Date-Time

yyyy-MM-dd HH:mm:ss

VISIBLE_TO

string

Contact Visibility

Contact visibility.

BACKGROUND

string

Background

Background

DEFAULT_LINKED_ORGANISATION

integer(int32)

Default Linked Organization

Default linked organization.

OWNER_USER_ID

integer(int32)

Owner User Id

The unique identifier of the owner.

DATE_UPDATED_UTC

string

Updated Date-Time

yyyy-MM-dd HH:mm:ss

VISIBLE_TEAM_ID

integer(int32)

Visible Team Id

The unique identifier of the team.

VISIBLE_USER_IDS

integer(int32)

Visible User IDs

The unique identifiers of the users.

CAN_EDIT

boolean

Can Edit

Can edit

CAN_DELETE

boolean

Can Delete

Can delete

SOCIAL_LINKEDIN

string

Social LinkedIn

Social LinkedIn.

SOCIAL_FACEBOOK

string

Social Facebook

Social Facebook.

SOCIAL_TWITTER

string

Social Twitter

Social Twitter.

 

ADDRESS_WORK

Summary: Address (Work)

Description:

 

          Properties:

Name

Type

Summary

STREET

string

Street

Address street.

CITY

string

City

Address city.

STATE

string

State

Address state.

POSTCODE

string

Postcode

Address postcode.

COUNTRY

string

Country

Address country.

 

ADDRESS_HOME

Summary: Address (Home)

Description:

 

          Properties:

Name

Type

Summary

STREET

string

Street

Address street.

CITY

string

City

Address city.

STATE

string

State

Address state.

POSTCODE

string

Postcode

Address postcode.

COUNTRY

string

Country

Address country.

 

ADDRESS_POSTAL

Summary: Address (Postal)

Description:

 

          Properties:

Name

Type

Summary

STREET

string

Street

Address street.

CITY

string

City

Address city.

STATE

string

State

Address state.

POSTCODE

string

Postcode

Address postcode.

COUNTRY

string

Country

Address country.

 

ADDRESS_PRIMARY

Summary: Address (Primary)

Description:

 

          Properties:

Name

Type

Summary

STREET

string

Street

Address street.

CITY

string

City

Address city.

STATE

string

State

Address state.

POSTCODE

string

Postcode

Address postcode.

COUNTRY

string

Country

Address country.

 

ADDRESS_OTHER

Summary: Address (Other)

Description:

 

          Properties:

Name

Type

Summary

STREET

string

Street

Address street.

CITY

string

City

Address city.

STATE

string

State

Address state.

POSTCODE

string

Postcode

Address postcode.

COUNTRY

string

Country

Address country.

 


 

ContactInfo

Summary:

Description: An Insightly Contact Information Object

 

          Properties:

Name

Type

Summary

CONTACT_INFO_ID

integer(int32)

Contact info Id

The unique identifier of the contact info.

TYPE

string

Type

Contact info type.  Values: [Phone, Email, Social, Website]

SUBTYPE

string

SubType

Contact info sub-type.

LABEL

string

Label

Contact info label.

DETAIL

string

Detail

Contact info detail.


 

ContactRequest

Summary:

Description: An Insightly Contact Request Object

 

          Properties:

Name

Type

Summary

SALUTATION

string

Salutation

The salutation of the contact.

FIRST_NAME

string

First Name

First name of the contact.

LAST_NAME

string

Last Name

Last name of the lead.

BACKGROUND

string

Background

Background

VISIBLE_TO

string

Contact Visibility

Contact Visibility  Values: [Everyone, Individuals, Owner, Team]

VISIBLE_TEAM_ID

integer(int32)

Visible Team Id

Visible Team Id (Required when team visibility state is selected)

VISIBLE_USER_IDS

integer(int32)

Visible User IDs

Visible User IDs (Required when individuals visibility state is selected)

CONTACTINFOS

array of (ContactInfo)

Contact Information

Contact Information

TAGS

array of (Tag)

Tag

Tag


 

Event

Summary:

Description: An Insightly Event Object

 

          Properties:

Name

Type

Summary

EVENT_ID

integer(int32)

Event Id

The unique identifier of the event.

TITLE

string

Title

The title of the event.

START_DATE_UTC

string

Start Date-Time

yyyy-MM-dd HH:mm:ss

END_DATE_UTC

string

End Date-Time

yyyy-MM-dd HH:mm:ss

DATE_CREATED_UTC

string

Created Date-Time

yyyy-MM-dd HH:mm:ss

DATE_UPDATED_UTC

string

Updated Date-Time

yyyy-MM-dd HH:mm:ss

OWNER_USER_ID

integer(int32)

Owner User Id

The unique identifier of the owner.

REMINDER_SENT

boolean

Is Reminder Sent

A boolean value determining whether or not the reminder was sent.

ALL_DAY

boolean

Is All Day Event

A boolean value determining whether or not the event is all day.

PUBLICLY_VISIBLE

boolean

Is Event Visible

A boolean value determining whether or not the event is publicly visible.

CAN_EDIT

boolean

Can Edit

Can edit

CAN_DELETE

boolean

Can Delete

Can delete


 

Lead

Summary:

Description: An Insightly Lead Object

 

          Properties:

Name

Type

Summary

LEAD_ID

integer(int32)

Lead Id

The unique identifier of the lead.

SALUTATION

string

Salutation

The salutation of the lead.

TITLE

string

Title

The title of the lead.

FIRST_NAME

string

First Name

First name of the lead.

LAST_NAME

string

Last Name

Last name of the lead.

LEAD_DESCRIPTION

string

Lead Description

A brief description of the lead.

DATE_CREATED_UTC

string

Created Date-Time

yyyy-MM-dd HH:mm:ss

DATE_UPDATED_UTC

string

Updated Date-Time

yyyy-MM-dd HH:mm:ss

CONVERTED_DATE_UTC

string

Converted Date-Time

yyyy-MM-dd HH:mm:ss

LEAD_STATUS_ID

integer(int32)

Lead Status Id

The status Id of the lead.

VISIBLE_TO

string

Lead Visibility

Lead visibility.

ORGANIZATION_NAME

string

Organization Name

The name of the organization.

PHONE_NUMBER

string

Phone Number

Lead phone number.

MOBILE_PHONE_NUMBER

string

Mobile Phone Number

Lead mobile phone number.

EMAIL_ADDRESS

string

Email Address

Lead email address.

CONVERTED

boolean

Is Converted

A boolean value determining whether or not the lead is converted.

WEBSITE_URL

string

Website URL

Lead website URL

OWNER_USER_ID

integer(int32)

Lead Owner

The unique identifier of the lead owner.

RESPONSIBLE_USER_ID

integer(int32)

Lead Responsible

The unique identifier of the responsible user.

EMPLOYEE_COUNT

integer(int32)

Lead Employee Count

The employee count of the lead.

LEAD_RATING

integer(int32)

Lead Rating

The rating of the lead.

INDUSTRY

string

Industry

The industry of the lead.

ADDRESS_STREET

string

Address Street

Address street.

ADDRESS_CITY

string

Address City

Address city.

ADDRESS_STATE

string

Address State

Address state.

ADDRESS_POSTCODE

string

Address Postcode

Address postcode.

ADDRESS_COUNTRY

string

Address Country

Address country.

FAX_NUMBER

string

Fax Number

Lead fax number.

CONVERTED_CONTACT_ID

integer(int32)

Converted Contact Id

The unique identifier of the converted contact.

CONVERTED_ORGANIZATION_ID

integer(int32)

Converted Organization Id

The unique identifier of the converted organization.

CONVERTED_OPPORTUNITY_ID

integer(int32)

Converted Opportunity Id

The unique identifier of the opportunity.

LEAD_SOURCE_ID

integer(int32)

Lead Source Id

The unique identifier of the lead source.

VISIBLE_TEAM_ID

integer(int32)

Visible Team Id

The unique identifier of the team.

VISIBLE_USER_IDS

integer(int32)

Visible User IDs

The unique identifiers of the users.

IMAGE_URL

string

Image URL

Lead Image URL

CAN_EDIT

boolean

Can Edit

Can edit

CAN_DELETE

boolean

Can Delete

Can delete


 

LeadRequest

Summary:

Description: An Insightly LeadRequest Object

 

          Properties:

Name

Type

Summary

TITLE

string

Title

The title of the lead.

FIRST_NAME

string

First Name

First name of the lead.

LAST_NAME

string

Last Name

Last name of the lead.

LEAD_DESCRIPTION

string

Lead Description

A brief description of the lead.

CONVERTED_DATE_UTC

string

Converted Date-Time

yyyy-MM-dd HH:mm:ss

VISIBLE_TO

string

Lead Visibility

Lead Visibility  Values: [Everyone, Individuals, Owner, Team]

VISIBLE_TEAM_ID

integer(int32)

Visible Team Id

Visible Team Id (Required when team visibility state is selected)

VISIBLE_USER_IDS

integer(int32)

Visible User IDs

Visible User IDs (Required when individuals visibility state is selected)

ORGANIZATION_NAME

string

Organization Name

The name of the organization.

PHONE_NUMBER

string

Phone Number

Lead phone number.

MOBILE_PHONE_NUMBER

string

Mobile Phone Number

Lead mobile phone number.

EMAIL_ADDRESS

string

Email Address

Lead email address.

CONVERTED

boolean

Is Converted

A boolean value determining whether or not the lead is converted.

WEBSITE_URL

string

Website URL

Lead website URL

OWNER_USER_ID

integer(int32)

Lead Owner

The unique identifier of the lead owner.

RESPONSIBLE_USER_ID

integer(int32)

Lead Responsible

The unique identifier of the responsible user.

EMPLOYEE_COUNT

integer(int32)

Lead Employee Count

The employee count of the lead.

LEAD_RATING

integer(int32)

Lead Rating

The rating of the lead.

INDUSTRY

string

Industry

The industry of the lead.

TAGS

array of (Tag)

Tag

Tag


 

ListContactsResponse

Summary:

Description: A Insightly contact response object

 

          Properties:

Name

Type

Summary

contacts

array of (Contact)

Contacts

A collection of contacts


 

ListEventsResponse

Summary:

Description: A Insightly Event response object

 

          Properties:

Name

Type

Summary

events

array of (Event)

Events

A collection of events


 

ListLeadsResponse

Summary:

Description: A Insightly Lead response object

 

          Properties:

Name

Type

Summary

leads

array of (Lead)

Leads

A collection of leads


 

ListProjectsResponse

Summary:

Description: A Insightly Project response object

 

          Properties:

Name

Type

Summary

projects

array of (Project)

Projects

A collection of projects


 

ListTasksResponse

Summary:

Description: An Insightly Tasks response object.

 

          Properties:

Name

Type

Summary

tasks

array of (Task)

Tasks

A collection of tasks


 

ListUsersResponse

Summary:

Description: A Insightly User response object

 

          Properties:

Name

Type

Summary

users

array of (User)

Users

A collection of users


 

Object

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Organization

Summary:

Description: An Insightly Organization Object

 

          Properties:

Name

Type

Summary

ORGANISATION_ID

integer(int32)

Organization Id

The unique identifier of the organization.

ORGANISATION_BACKGROUND

string

Organization Background

The background of the organization.

ORGANISATION_NAME

string

Organization Name

The name of the organization.

DATE_CREATED_UTC

string

Created Date-Time

yyyy-MM-dd HH:mm:ss

DATE_UPDATED_UTC

string

Updated Date-Time

yyyy-MM-dd HH:mm:ss

OWNER_USER_ID

integer(int32)

Organization Owner

The unique identifier of the owner.

VISIBLE_TO

string

Organization Visibility

Organization visibility.

ADDRESSES

array of (Address)

Organization

Organization Addresses

CONTACTINFOS

array of (ContactInfo)

Contact Information

Contact Information

BACKGROUND

string

Background

The background of the organization.

IMAGE_URL

string

Image URL

Organization image URL.

VISIBLE_TEAM_ID

integer(int32)

Visible Team Id

The unique identifier of the team.

VISIBLE_USER_IDS

integer(int32)

Visible User IDs

The unique identifiers of the users.


 

OrganizationRequest

Summary:

Description: An Insightly Organization Request Object

 

          Properties:

Name

Type

Summary

ORGANISATION_NAME

string

Organization Name

The name of the organization.

ORGANISATION_BACKGROUND

string

Organization Background

The background of the organization.

VISIBLE_TO

string

Organization Visibility

Organization visibility.  Values: [Everyone, Individuals, Owner, Team]

VISIBLE_TEAM_ID

integer(int32)

Visible Team Id

Visible Team Id (Required when team visibility state is selected)

VISIBLE_USER_IDS

integer(int32)

Visible User IDs

Visible User IDs (Required when individuals visibility state is selected)

ADDRESSES

array of (Address)

Organization Address

Organization Addresses

CONTACTINFOS

array of (ContactInfo)

Contact Information

Contact Information

TAGS

array of (Tag)

Tags

Tags


 

Project

Summary:

Description: An Insightly Project Object

 

          Properties:

Name

Type

Summary

PROJECT_ID

integer(int32)

Project Id

The unique identifier of the project.

PROJECT_NAME

string

Project Name

The name of the project.

STATUS

string

Project Status

The status of the project.

PROJECT_DETAILS

string

Project Details

The details of the project.

IMAGE_URL

string

Image URL

The image URL of the project.

DATE_CREATED_UTC

string

Created Date-Time

yyyy-MM-dd HH:mm:ss

VISIBLE_TO

string

Project Visible

Project Visibility.

DATE_UPDATED_UTC

string

Updated Date-Time

yyyy-MM-dd HH:mm:ss

STARTED_DATE

string

Started Date-Time

yyyy-MM-dd HH:mm:ss

COMPLETED_DATE

string

Completed Date-Time

yyyy-MM-dd HH:mm:ss

OWNER_USER_ID

integer(int32)

Project Owner

The unique identifier of the project owner.

RESPONSIBLE_USER_ID

integer(int32)

Assigned To

The unique identifier of the assigned user.

OPPORTUNITY_ID

integer(int32)

Opportunity Id

The unique identifier of the opportunity.

PIPELINE_ID

integer(int32)

Pipeline Id

The unique identifier of the pipeline.

STAGE_ID

integer(int32)

Stage Id

The unique identifier of the stage.

CATEGORY_ID

integer(int32)

Category Id

The unique identifier of the category.

VISIBLE_TEAM_ID

integer(int32)

Visible Team Id

The unique identifier of the team.

VISIBLE_USER_IDS

integer(int32)

Visible User IDs

The unique identifiers of the users.

CAN_EDIT

boolean

Can Edit

Can edit

CAN_DELETE

boolean

Can Delete

Can delete


 

ProjectRequest

Summary:

Description: An Insightly Project Object

 

          Properties:

Name

Type

Summary

PROJECT_NAME

string

Project Name

The name of the project.

PROJECT_DETAILS

string

Project Details

The details of the project.

STATUS

string

Project Status

The status of the project.  Values: [Completed, Deferred, In Progress, Not Started, Abandoned, Cancelled]

IMAGE_URL

string

Image URL

The image URL of the project.

VISIBLE_TO

string

Project Visibility

Project Visibility.  Values: [Everyone, Individuals, Owner, Team]

VISIBLE_TEAM_ID

integer(int32)

Visible Team Id

Visible Team Id (Required when team visibility state is selected)

VISIBLE_USER_IDS

integer(int32)

Visible User IDs

Visible User IDs (Required when individuals visibility state is selected)

OPPORTUNITY_ID

integer(int32)

Opportunity Id

The unique identifier of the opportunity.

PIPELINE_ID

integer(int32)

Pipeline Id

The unique identifier of the pipeline.

STAGE_ID

integer(int32)

Stage Id

The unique identifier of the stage.

TAGS

array of (Tag)

Tags

Tags


 

Tag

Summary:

Description: A Tag Object

 

          Properties:

Name

Type

Summary

TAG_NAME

string

Tag Name

The name of the tag.


 

Task

Summary:

Description: An Insightly Task Object

 

          Properties:

Name

Type

Summary

TASK_ID

integer(int32)

Task Id

The unique identifier of the task.

TITLE

string

Task Title

The title of the task.

DUE_DATE

string

Due Date-Time

yyyy-MM-dd HH:mm:ss

CATEGORY_ID

integer(int32)

Category Id

The unique identifier of the category.

COMPLETED_DATE_UTC

string

Completed Date-Time

yyyy-MM-dd HH:mm:ss

COMPLETED

boolean

Is Completed

A boolean value determining whether or not the task is completed.

DETAILS

string

Task Details

The details of the task.

STATUS

string

Task Status

The status of the task.  Values: [Completed, Deferred, In Progress, Not Started, Waiting]

PRIORITY

string

Task Priority

The priority of the task.

START_DATE

string

Start Date-Time

yyyy-MM-dd HH:mm:ss

PROJECT_ID

integer(int32)

Project Id

The unique identifier of the project.

OPPORTUNITY_ID

integer(int32)

Opportunity Id

The unique identifier of the opportunity.

MILESTONE_ID

integer(int32)

Milestone Id

The unique identifier of the milestone.

PIPELINE_ID

integer(int32)

Pipeline Id

The unique identifier of the pipeline.

STAGE_ID

integer(int32)

Stage Id

The unique identifier of the stage.

PERCENT_COMPLETE

integer(int32)

Percentage Complete

The task completed value in percent.

OWNER_USER_ID

integer(int32)

Task Owner

The unique identifier of the task owner.

RESPONSIBLE_USER_ID

integer(int32)

Assigned To

The unique identifier of the user assigned to the task.

PUBLICLY_VISIBLE

boolean

Is Task Visible

A boolean value determining whether or not the task is publicly visible.

DATE_CREATED_UTC

string

Created Date-Time

yyyy-MM-dd HH:mm:ss

DATE_UPDATED_UTC

string

Updated Date-Time

yyyy-MM-dd HH:mm:ss

ASSIGNED_BY_USER_ID

integer(int32)

Assigned by User Id

The unique identifier of the assigned by user.

PARENT_TASK_ID

integer(int32)

Parent Task Id

The unique identifier of the parent task.

OWNER_VISIBLE

boolean

Is Owner Visible

A boolean value determining whether or not the owner is publicly visible.

ASSIGNED_TEAM_ID

integer(int32)

Assigned Team Id

The unique identifier of the assigned team.

ASSIGNED_DATE_UTC

integer(int32)

Assigned Date-Time

yyyy-MM-dd HH:mm:ss

REMINDER_DATE_UTC

integer(int32)

Reminder Date-Time

yyyy-MM-dd HH:mm:ss

REMINDER_SENT

boolean

Is Reminder Sent

A boolean value determining whether or not a reminder is set.

RECURRENCE

string

Recurrence

Recurrence

CAN_EDIT

boolean

Can Edit

Can edit.

CAN_DELETE

boolean

Can Delete

Can delete


 

TaskRequest

Summary:

Description: An Insightly Task Request Object

 

          Properties:

Name

Type

Summary

TITLE

string

Task Title

The title of the task.

DUE_DATE

string

Due Date-Time

yyyy-MM-dd HH:mm:ss

COMPLETED

boolean

Is Completed

A boolean value determining whether or not the task is completed.

DETAILS

string

Task Details

The details of the task.

STATUS

string

Task Status

The status of the task.  Values: [Completed, Deferred, In Progress, Not Started, Waiting]

PRIORITY

integer(int32)

Task Priority

The priority of the task.

PUBLICLY_VISIBLE

boolean

Is Task Visible

A boolean value determining whether or not the task is publicly visible.


 

User

Summary:

Description: An Insightly User Object

 

          Properties:

Name

Type

Summary

USER_ID

integer(int32)

User Id

The unique identifier of the user.

CONTACT_ID

integer(int32)

Contact Id

The unique identifier of the contact.

FIRST_NAME

string

First Name

First name of the user.

LAST_NAME

string

Last Name

Last name of the user.

EMAIL_ADDRESS

string

Email Address

User email address.

TIMEZONE_ID

string

Time zone Id

The unique identifier of the timezone.

EMAIL_DROPBOX_IDENTIFIER

string

Email Dropbox Id

The unique identifier of the email dropbox.

EMAIL_DROPBOX_ADDRESS

string

Email Dropbox Address

Email dropbox address

ADMINISTRATOR

boolean

Is Administrator

A boolean value determining whether or not the user is an administrator.

ACCOUNT_OWNER

boolean

Is Account Owner

A boolean value determining whether or not the user is the account owner.

ACTIVE

boolean

Is Active

A boolean value determining whether or not the user is active.

DATE_CREATED_UTC

string

Created Date-Time

yyyy-MM-dd HH:mm:ss

DATE_UPDATED_UTC

string

Updated Date-Time

yyyy-MM-dd HH:mm:ss

USER_CURRENCY

string

User Currency

User currency.

CONTACT_DISPLAY

string

Contact Display

Contact display.

CONTACT_ORDER

string

Contact Order

Contact order.

TASK_WEEK_START

integer(int32)

Task Week Start

Task week start.

INSTANCE_ID

integer(int32)

Instance Id

The unique identifier of the instance.