INinsightly
Contacts

Gets a list of Contacts filtered by tags

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

get/Contacts/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.

CONTACT_IDinteger
SALUTATIONstring string
FIRST_NAMEstring string required
LAST_NAMEstring string
IMAGE_URLstring string
BACKGROUNDstring string
OWNER_USER_IDinteger
DATE_CREATED_UTCstring date-time
DATE_UPDATED_UTCstring date-time
SOCIAL_LINKEDINstring string
SOCIAL_FACEBOOKstring string
SOCIAL_TWITTERstring string
DATE_OF_BIRTHstring date-time
PHONEstring string
PHONE_HOMEstring string
PHONE_MOBILEstring string
PHONE_OTHERstring string
PHONE_ASSISTANTstring string
PHONE_FAXstring string
EMAIL_ADDRESSstring string
ASSISTANT_NAMEstring string
ADDRESS_MAIL_STREETstring string
ADDRESS_MAIL_CITYstring string
ADDRESS_MAIL_STATEstring string
ADDRESS_MAIL_POSTCODEstring string
ADDRESS_MAIL_COUNTRYstring string
ADDRESS_OTHER_STREETstring string
ADDRESS_OTHER_CITYstring string
ADDRESS_OTHER_STATEstring string
ADDRESS_OTHER_POSTCODEstring string
ADDRESS_OTHER_COUNTRYstring string
LAST_ACTIVITY_DATE_UTCstring date-time
NEXT_ACTIVITY_DATE_UTCstring date-time
CREATED_USER_IDinteger
ORGANISATION_IDinteger
TITLEstring string
EMAIL_OPTED_OUTboolean

Changes

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