GET v1/{organizationId}/contacts/{contactGuid}/notes?fields={fields}&deletedOnly={deletedOnly}&page={page}&pageSize={pageSize}
Retrieve a list of notes for the contact ordered by NoteDate.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
contactGuid |
Guid of the contact |
globally unique identifier |
Required |
fields |
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. |
string |
Default value is Id,NoteDate,Text |
deletedOnly |
[Generic Filter Option] Only select deleted notes. If left empty, will default to false. |
boolean |
Default value is False |
page |
The 0-based page number |
integer |
Default value is 0 |
pageSize |
The maximum number of items to include in a page. Maximum 1000. |
integer |
Default value is 100 |
organizationId | string |
None. |
Body Parameters
Response Information
Resource Description
200 (OK) Returns a collection of notes for the contact (with only the requested fields).
DineroCollectionOfContactNoteName | Description | Type |
---|---|---|
Collection |
Collection containing the result of the request. |
Collection of ContactNote |
Pagination |
Pagination information. |
PaginationDetails |
{ "Collection": [ { "Id": "3cbc7a70-0605-4367-b7fe-2bc67332bd1e", "NoteDate": "2019-02-17T01:11:42.3451296+00:00", "AuthorName": "sample string 3", "AuthorEmail": "sample string 4", "CreatedAt": "2019-02-17T01:11:42.3451296+00:00", "UpdatedAt": "2019-02-17T01:11:42.3451296+00:00", "DeletedAt": "2019-02-17T01:11:42.3451296+00:00", "Text": "sample string 5" }, { "Id": "3cbc7a70-0605-4367-b7fe-2bc67332bd1e", "NoteDate": "2019-02-17T01:11:42.3451296+00:00", "AuthorName": "sample string 3", "AuthorEmail": "sample string 4", "CreatedAt": "2019-02-17T01:11:42.3451296+00:00", "UpdatedAt": "2019-02-17T01:11:42.3451296+00:00", "DeletedAt": "2019-02-17T01:11:42.3451296+00:00", "Text": "sample string 5" } ], "Pagination": { "MaxPageSizeAllowed": 0, "PageSize": 0, "Result": 0, "ResultWithoutFilter": 0, "Page": 0 } }