Get the Notes for a Contact

GET

/api/ContactNote/ByContact/:contactId

GET

/api/ContactNote/ByContact/:contactId

curl -G https://api.virtuoussoftware.com/api/ContactNote/ByContact/contactId \
     -H "Authorization: Bearer <token>" \
     --data-urlencode sortBy=<string> \
     --data-urlencode descending=<boolean> \
     -d skip=1 \
     -d take=1

200Contacts and Individuals_getTheNotesForAContact_example

{
  "list": [
    {
      "id": "<integer>",
      "contactId": "<integer>",
      "createDateTimeUtc": "<dateTime>",
      "createdByUser": "<string>",
      "modifiedDateTimeUtc": "<dateTime>",
      "modifiedByUser": "<string>",
      "noteDate": "<string>",
      "type": "<string>",
      "note": "<string>",
      "important": "<boolean>",
      "isPrivate": "<boolean>",
      "createdByAvatarUrl": "<string>",
      "reminder": {
        "id": "<integer>",
        "message": "<string>",
        "targetDate": "<string>",
        "targetResolutionDateUtc": "<dateTime>",
        "contactId": "<integer>",
        "contactViewUrl": "<string>",
        "contactDisplayName": "<string>",
        "contactAvatarUrl": "<string>",
        "reminderType": "<string>",
        "reminderTypeDisplayName": "<string>",
        "taskStatus": "<string>",
        "taskStatusDisplayName": "<string>",
        "completeUrl": "<string>",
        "dismissUrl": "<string>",
        "description": "<string>",
        "hasContact": "<boolean>",
        "isPastDue": "<boolean>",
        "isUnresolved": "<boolean>",
        "canComplete": "<boolean>",
        "completeActionName": "<string>",
        "canCompleteWithNote": "<boolean>",
        "owner": "<string>",
        "ownerAvatarUrl": "<string>"
      }
    },
    {
      "id": "<integer>",
      "contactId": "<integer>",
      "createDateTimeUtc": "<dateTime>",
      "createdByUser": "<string>",
      "modifiedDateTimeUtc": "<dateTime>",
      "modifiedByUser": "<string>",
      "noteDate": "<string>",
      "type": "<string>",
      "note": "<string>",
      "important": "<boolean>",
      "isPrivate": "<boolean>",
      "createdByAvatarUrl": "<string>",
      "reminder": {
        "id": "<integer>",
        "message": "<string>",
        "targetDate": "<string>",
        "targetResolutionDateUtc": "<dateTime>",
        "contactId": "<integer>",
        "contactViewUrl": "<string>",
        "contactDisplayName": "<string>",
        "contactAvatarUrl": "<string>",
        "reminderType": "<string>",
        "reminderTypeDisplayName": "<string>",
        "taskStatus": "<string>",
        "taskStatusDisplayName": "<string>",
        "completeUrl": "<string>",
        "dismissUrl": "<string>",
        "description": "<string>",
        "hasContact": "<boolean>",
        "isPastDue": "<boolean>",
        "isUnresolved": "<boolean>",
        "canComplete": "<boolean>",
        "completeActionName": "<string>",
        "canCompleteWithNote": "<boolean>",
        "owner": "<string>",
        "ownerAvatarUrl": "<string>"
      }
    }
  ],
  "total": "<integer>"
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

contactIdstringRequired

Query parameters

sortBystringOptional

The field to be sorted. Supported: Id, NoteDate, CreatedDateTime.

descendingstringOptional

The direction to be sorted.

skipintegerOptional

The number of records to skip. Default = 0.

takeintegerOptional

The number of records to take. Default = 10.

Response

listlist of objectsOptional

totalstringOptional