GetContactNotes

Overview

Get notes for a specified contact via an http form post.

Each note returned includes a 'manualnote' field, which is always 1 or 0. A value of 1 means the note was entered manually on the contact card; 0 means it was created by the system (workflows, group actions, imports, the API, and so on). Use the optional 'manualnote' parameter below to return only one kind or the other.

URL

POST/api/2/GetContactNotes/       or legacy URL at  /api/2/GetContactNotes.aspx

form-data Parameters

FieldMax LengthRequiredNotes
response_typefalseDefault results will be returned in XML.
Set this field value to json to return results in JSON format
accountidtrueMust be numeric. Account ID for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel
apikeytrueAPI Key for this account.
Found in Settings > API Settings or for White Label CRM in the Admin control panel
identifymethod1trueValues:

1: By contactid (It's recommended that you use this method and store our contactid in your system)

2: By primary email on file. If there are multiple matches for the email address, we will choose the first one (by add date)

3: By email or other email on file. If there are multiple matches for the email address, we will choose the first one (by add date)
identifyvalue75trueValue changes based on identifymethod. Must be integer if contactid, otherwise must be an email address on file
manualnote1falseOptional filter. Leave this field out (or blank) to return all notes.

1: Only return notes that were entered manually on the contact card

0: Only return notes that were not entered manually (system notes, workflows, group actions, imports, API)

Note: notes added before this flag was introduced are not marked as manual, so a full historical pull will report them as 0.