INinsightly
Leads

Gets a filtered list of Leads

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.

get/Leads/Search

Request

  • Base URL
    https://api.insightly.com/v3.1
  • Auth
    none declared. Required headers: Authorization

Query parameters

field_namestring

Optional, field name for object

field_valuestring

Optional, field value of the record

updated_after_utcstring date-time

Optional, earliest date when a record was last updated.

briefboolean

Optional, true if response should only contain top level properties of the record.

skipinteger

Optional, number of records to skip.

topinteger

Optional, maximum number of records to return in the response.

count_totalboolean

Optional, true if total number of records should be returned in the response headers.

Headers

Authorizationstring required

Authorization

Response

Request succeeded.

LEAD_IDinteger required
SALUTATIONstring string
FIRST_NAMEstring string
LAST_NAMEstring string required
LEAD_SOURCE_IDinteger required
LEAD_STATUS_IDinteger required
TITLEstring string
CONVERTEDboolean
CONVERTED_CONTACT_IDinteger
CONVERTED_DATE_UTCstring date-time
CONVERTED_OPPORTUNITY_IDinteger
CONVERTED_ORGANISATION_IDinteger
DATE_CREATED_UTCstring date-time
DATE_UPDATED_UTCstring date-time
EMAILstring string
EMPLOYEE_COUNTinteger
FAXstring string
INDUSTRYstring string
LEAD_DESCRIPTIONstring string
LEAD_RATINGinteger
MOBILEstring string
OWNER_USER_IDinteger
PHONEstring string
RESPONSIBLE_USER_IDinteger
WEBSITEstring string
ADDRESS_STREETstring string
ADDRESS_CITYstring string
ADDRESS_STATEstring string
ADDRESS_POSTCODEstring string
ADDRESS_COUNTRYstring string
LAST_ACTIVITY_DATE_UTCstring date-time
NEXT_ACTIVITY_DATE_UTCstring date-time
ORGANISATION_NAMEstring string
CREATED_USER_IDinteger
IMAGE_URLstring string
EMAIL_OPTED_OUTboolean
LINKED_EMAIL_ADDRESSstring string

Changes

No recorded changes to this operation across all 1 revision of this API.