List contact notes

Retrieve a list of notes for the contact ordered by NoteDate.

Query parameters

NameDescription
contactGuid globally unique identifier

Guid of the contact

Required

fields string

A comma separated list of fields to include in the response. Possible values are Id, NoteDate, Text, AuthorName, AuthorEmail, CreatedAt, UpdatedAt and DeletedAt. Notice that it's not case sensitive, the property name will be returned the way you request it. If left empty it defaults to Id, NoteDate and Text.

Default value is Id,NoteDate,Text

deletedOnly boolean

[Generic Filter Option] Only select deleted notes. If left empty, will default to false.

Default value is False

page integer

The 0-based page number

Default value is 0

pageSize integer

The maximum number of items to include in a page. Maximum 1000.

Default value is 100

organizationId string

Returns

200 (OK) Returns a collection of notes for the contact (with only the requested fields).

NameDescription
Collection ContactNote[] Show model
NameDescription
Id globally unique identifier

Guid of the note

NoteDate date

Date of which the note was created

AuthorName string

Name of the author of the note

AuthorEmail string

Email of the author of the note

CreatedAt date

Time at which the note was created

UpdatedAt date

Time at which the note was last updated

DeletedAt date

Time at which the note as deleted

Text string

The body text of the note

Collection containing the result of the request.

Pagination PaginationDetails Show model
NameDescription
MaxPageSizeAllowed integer

Maximum number of result pr. page.

PageSize integer

Number of result pr. page.

Result integer

Number of results returned in the collection.

ResultWithoutFilter integer

Result count before pagination.

Page integer

The 0-based page number.

Pagination information.

v1/{organizationId}/contacts/{contactGuid}/notes?fields={fields}&deletedOnly={deletedOnly}&page={page}&pageSize={pageSize}

Response Formats

{
  "Collection": [
    {
      "Id": "14952bc3-0276-4d4d-9619-4b50e87deae5",
      "NoteDate": "2019-09-22T12:41:41.241311Z",
      "AuthorName": "sample string 3",
      "AuthorEmail": "sample string 4",
      "CreatedAt": "2019-09-22T12:41:41.241311Z",
      "UpdatedAt": "2019-09-22T12:41:41.241311Z",
      "DeletedAt": "2019-09-22T12:41:41.241311Z",
      "Text": "sample string 5"
    },
    {
      "Id": "14952bc3-0276-4d4d-9619-4b50e87deae5",
      "NoteDate": "2019-09-22T12:41:41.241311Z",
      "AuthorName": "sample string 3",
      "AuthorEmail": "sample string 4",
      "CreatedAt": "2019-09-22T12:41:41.241311Z",
      "UpdatedAt": "2019-09-22T12:41:41.241311Z",
      "DeletedAt": "2019-09-22T12:41:41.241311Z",
      "Text": "sample string 5"
    }
  ],
  "Pagination": {
    "MaxPageSizeAllowed": 0,
    "PageSize": 0,
    "Result": 0,
    "ResultWithoutFilter": 0,
    "Page": 0
  }
}