get-contact-note-list.md

Get Contact Note List

{% swagger baseUrl="[PlatformAddress]/api/1.0/" path="contact?action=getContactNoteList" method="post" summary="Get Contact Note List" %} {% swagger-description %} Fetches a list of notes for a specific contact. {% endswagger-description %}

{% swagger-parameter name="contactId" type="integer" in="path" %} The unique identifier of the contact to which the contact notes belong {% endswagger-parameter %}

{% swagger-parameter name="perPage" type="integer" in="path" %} The number of contact notes to fetch {% endswagger-parameter %}

{% swagger-parameter name="start" type="integer" in="path" %} The starting result of the page. Note this is zero based (i.e. sending start=0 will start from the first result.) {% endswagger-parameter %}

{% swagger-response status="200" description="" %}

{
    "meta": {
        "totalResults": 10,
        "start": 0,
        "perPage": 50,
        "count": 3
    },
    "results": [
        {
            "id": 2,
            "contactId": 4,
            "noteText": "<p>Contact Note 1</p>\n",
            "createdByUserId": 1,
            "createdDate": "2022-06-12 06:06:03 UTC",
            "modifiedDate": "2022-07-13 01:32:10"
        },
        {
            "id": 4,
            "contactId": 4,
            "noteText": "<p>Contact Note 2</p>\n",
            "createdByUserId": 1,
            "createdDate": "2022-07-13 01:27:27 UTC",
            "modifiedDate": "2022-07-13 01:27:27"
        },
        {
            "id": 5,
            "contactId": 4,
            "noteText": "<p>Contact Note 3</p>\n",
            "createdByUserId": 1,
            "createdDate": "2022-07-13 01:29:41 UTC",
            "modifiedDate": "2022-07-13 01:29:41"
        },
    ]
}

{% endswagger-response %} {% endswagger %}

The result from this call will be a collection of contact note to which the user has access. This call also accepts the pagination and filter properties.

Example Request

Fetches a list of Notes for a specific Contact

{
    "contactId" : 4,
    "perPage" : 50
}

Contact Note

Property	Type	Description
id	integer	The unique id of the contact note
contactId	integer	The id of the contact to which the contact note belongs
noteText	string	The contact note
createdByUserId	integer	The details of person who created the contact note
createdDate	timestamp	The date & time the contact note was created
modifiedDate	timestamp	The date & time the contact note was last modified