Query Contact Notes
POST {{baseUrl}}/api/ContactNote/Query?skip=<integer>&take=<integer>
To see which options can be sent, use the {M:Virtuous.WebApi.Controllers.ContactNoteController.QueryOptions} endpoint. If you're going to consistently query for updated contact notes or new contact notes, don't. Use a webhook instead. If requests are timing out, you may be asking for too many items at once. The max take is 1,000.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
skip | string | The number of records to skip. Default = 0. | |
take | string | The number of records to take. Default = 10. Max is 1000. |
Request Body
{"groups"=>[{"conditions"=>[{"parameter"=>"<string>", "operator"=>"<string>", "value"=>"<string>", "secondaryValue"=>"<string>", "values"=>["<string>", "<string>"]}, {"parameter"=>"<string>", "operator"=>"<string>", "value"=>"<string>", "secondaryValue"=>"<string>", "values"=>["<string>", "<string>"]}]}, {"conditions"=>[{"parameter"=>"<string>", "operator"=>"<string>", "value"=>"<string>", "secondaryValue"=>"<string>", "values"=>["<string>", "<string>"]}, {"parameter"=>"<string>", "operator"=>"<string>", "value"=>"<string>", "secondaryValue"=>"<string>", "values"=>["<string>", "<string>"]}]}], "sortBy"=>"<string>", "descending"=>"<boolean>"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"list":[{"id":"\u003cinteger\u003e","contactId":"\u003cinteger\u003e","createDateTimeUtc":"\u003cdateTime\u003e","createdByUser":"\u003cstring\u003e","modifiedDateTimeUtc":"\u003cdateTime\u003e","modifiedByUser":"\u003cstring\u003e","noteDate":"\u003cstring\u003e","type":"\u003cstring\u003e","note":"\u003cstring\u003e","important":"\u003cboolean\u003e","isPrivate":"\u003cboolean\u003e","createdByAvatarUrl":"\u003cstring\u003e","reminder":{"id":"\u003cinteger\u003e","message":"\u003cstring\u003e","targetDate":"\u003cstring\u003e","targetResolutionDateUtc":"\u003cdateTime\u003e","contactId":"\u003cinteger\u003e","contactViewUrl":"\u003cstring\u003e","contactDisplayName":"\u003cstring\u003e","contactAvatarUrl":"\u003cstring\u003e","reminderType":"\u003cstring\u003e","reminderTypeDisplayName":"\u003cstring\u003e","taskStatus":"\u003cstring\u003e","taskStatusDisplayName":"\u003cstring\u003e","completeUrl":"\u003cstring\u003e","dismissUrl":"\u003cstring\u003e","description":"\u003cstring\u003e","hasContact":"\u003cboolean\u003e","isPastDue":"\u003cboolean\u003e","isUnresolved":"\u003cboolean\u003e","canComplete":"\u003cboolean\u003e","completeActionName":"\u003cstring\u003e","canCompleteWithNote":"\u003cboolean\u003e","owner":"\u003cstring\u003e","ownerAvatarUrl":"\u003cstring\u003e"}},{"id":"\u003cinteger\u003e","contactId":"\u003cinteger\u003e","createDateTimeUtc":"\u003cdateTime\u003e","createdByUser":"\u003cstring\u003e","modifiedDateTimeUtc":"\u003cdateTime\u003e","modifiedByUser":"\u003cstring\u003e","noteDate":"\u003cstring\u003e","type":"\u003cstring\u003e","note":"\u003cstring\u003e","important":"\u003cboolean\u003e","isPrivate":"\u003cboolean\u003e","createdByAvatarUrl":"\u003cstring\u003e","reminder":{"id":"\u003cinteger\u003e","message":"\u003cstring\u003e","targetDate":"\u003cstring\u003e","targetResolutionDateUtc":"\u003cdateTime\u003e","contactId":"\u003cinteger\u003e","contactViewUrl":"\u003cstring\u003e","contactDisplayName":"\u003cstring\u003e","contactAvatarUrl":"\u003cstring\u003e","reminderType":"\u003cstring\u003e","reminderTypeDisplayName":"\u003cstring\u003e","taskStatus":"\u003cstring\u003e","taskStatusDisplayName":"\u003cstring\u003e","completeUrl":"\u003cstring\u003e","dismissUrl":"\u003cstring\u003e","description":"\u003cstring\u003e","hasContact":"\u003cboolean\u003e","isPastDue":"\u003cboolean\u003e","isUnresolved":"\u003cboolean\u003e","canComplete":"\u003cboolean\u003e","completeActionName":"\u003cstring\u003e","canCompleteWithNote":"\u003cboolean\u003e","owner":"\u003cstring\u003e","ownerAvatarUrl":"\u003cstring\u003e"}}],"total":"\u003cinteger\u003e"}