INinsightly
Prospects

Gets a list of Prospects filtered by tags

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

get/Prospect/SearchByTag

Request

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

Query parameters

tagNamestring required

Tag name to filter on

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.

PROSPECT_IDinteger
LEAD_IDinteger
CONTACT_IDinteger
ORGANISATION_IDinteger
SALUTATIONstring string
FIRST_NAMEstring string
LAST_NAMEstring string
ORGANISATION_NAMEstring string
TITLEstring string
EMAIL_ADDRESSstring string required
PHONEstring string
MOBILEstring string
FAXstring string
WEBSITEstring string
ADDRESS_STREETstring string
ADDRESS_CITYstring string
ADDRESS_STATEstring string
ADDRESS_POSTCODEstring string
ADDRESS_COUNTRYstring string
INDUSTRYstring string
EMPLOYEE_COUNTinteger
SCOREinteger
GRADEstring string
DESCRIPTIONstring string
DO_NOT_EMAILboolean
DO_NOT_CALLboolean
OPTED_OUTboolean
LAST_ACTIVITY_DATE_UTCstring date-time
CREATED_USER_IDinteger
OWNER_USER_IDinteger
DATE_CREATED_UTCstring date-time
DATE_UPDATED_UTCstring date-time
DO_NOT_SYNCboolean
LEAD_CONVERSION_DATE_UTCstring date-time
GRADE_PROFILE_IDinteger

Changes

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