Insightly

Links

    Insightly API

    Getting access, Developing, Testing

    Back to Insightly

    Gets A Filtered List Of Prospects

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

    Input

    type: object properties: parameters: type: object properties: field_name: type: string description: Optional, field name for object field_value: type: string description: Optional, field value of the record updated_after_utc: type: string description: Optional, earliest date when a record was last updated. brief: type: string description: >- Optional, true if response should only contain top level properties of the record. skip: type: string description: Optional, number of records to skip. top: type: string description: Optional, maximum number of records to return in the response. count_total: type: string description: >- Optional, true if total number of records should be returned in the response headers. title: Parameters

    Output

    type: array items: type: object title: Prospect properties: PROSPECT_ID: format: int64 maxLength: 0 type: integer readOnly: true LEAD_ID: format: int64 maxLength: 0 type: integer readOnly: true CONTACT_ID: format: int64 maxLength: 0 type: integer readOnly: true ORGANISATION_ID: format: int64 maxLength: 0 type: integer readOnly: true SALUTATION: format: string maxLength: 50 type: string readOnly: false FIRST_NAME: format: string maxLength: 255 type: string readOnly: false LAST_NAME: format: string maxLength: 255 type: string readOnly: false ORGANISATION_NAME: format: string maxLength: 255 type: string readOnly: false TITLE: format: string maxLength: 255 type: string readOnly: false EMAIL_ADDRESS: format: string maxLength: 255 type: string readOnly: false PHONE: format: string maxLength: 255 type: string readOnly: false MOBILE: format: string maxLength: 255 type: string readOnly: false FAX: format: string maxLength: 255 type: string readOnly: false WEBSITE: format: string maxLength: 255 type: string readOnly: false ADDRESS_STREET: format: string maxLength: 255 type: string readOnly: false ADDRESS_CITY: format: string maxLength: 255 type: string readOnly: false ADDRESS_STATE: format: string maxLength: 255 type: string readOnly: false ADDRESS_POSTCODE: format: string maxLength: 128 type: string readOnly: false ADDRESS_COUNTRY: format: string maxLength: 255 type: string readOnly: false INDUSTRY: format: string maxLength: 128 type: string readOnly: false EMPLOYEE_COUNT: format: int32 maxLength: 0 type: integer readOnly: false SCORE: format: int32 maxLength: 0 type: integer readOnly: true GRADE: format: string maxLength: 2 type: string readOnly: true DESCRIPTION: format: string maxLength: 4000 type: string readOnly: false DO_NOT_EMAIL: format: boolean maxLength: 0 type: boolean readOnly: false DO_NOT_CALL: format: boolean maxLength: 0 type: boolean readOnly: false OPTED_OUT: format: boolean maxLength: 0 type: boolean readOnly: false LAST_ACTIVITY_DATE_UTC: format: date-time maxLength: 0 type: string readOnly: true CREATED_USER_ID: format: int32 maxLength: 0 type: integer readOnly: true OWNER_USER_ID: format: int32 maxLength: 0 type: integer readOnly: false DATE_CREATED_UTC: format: date-time maxLength: 0 type: string readOnly: true DATE_UPDATED_UTC: format: date-time maxLength: 0 type: string readOnly: true DO_NOT_SYNC: format: boolean maxLength: 0 type: boolean readOnly: false LEAD_CONVERSION_DATE_UTC: format: date-time maxLength: 0 type: string readOnly: true GRADE_PROFILE_ID: format: int64 maxLength: 0 type: integer readOnly: false CUSTOMFIELDS: type: array items: type: object title: CustomField properties: FIELD_NAME: type: string FIELD_VALUE: type: object TAGS: type: array items: type: object title: Tag properties: TAG_NAME: maxLength: 255 minLength: 0 type: string