Sign in
latestSwagger 2.02026-08-101561322.2 MB

3e4029d19684

Contact Notes

Fetch notes assigned to a given contact

<a class="try-sandbox-link" href="https://sandbox.textmagic.com/#/Contact%20Notes/getContactNotes" target="_blank">Try in sandbox</a><br>

get/api/v2/contacts/{id}/notes

Path parameters

idinteger required

Query parameters

pageinteger

Fetch specified results page.

limitinteger

The number of results per page.

Response

Returned when successful.

pageinteger required
pageCountinteger required

The total number of pages.

limitinteger required

The number of results per page.

Example response

{
  "page": 1,
  "pageCount": 10,
  "limit": 10,
  "resources": [
    {
      "id": 5,
      "createdAt": "2015-06-19T09:48:24+0000",
      "note": "Test note",
      "user": {
        "id": 305,
        "displayTimeFormat": "24h",
        "username": "charles.conway",
        "firstName": "Charles",
        "lastName": "Conway",
        "email": "charles@example.com",
        "status": "A",
        "balance": 208.64,
        "phone": "447860021130",
        "company": "Example Ltd.",
        "currency": {
          "id": "GBP",
          "unicodeSymbol": "£",
          "htmlSymbol": "&pound;"
        },
        "country": {
          "id": "US",
          "name": "India"
        },
        "timezone": {
          "id": 55,
          "area": "Europe",
          "dst": 1,
          "offset": 10800,
          "timezone": "Europe\\/Tallinn"
        },
        "subaccountType": "P",
        "emailAccepted": true,
        "phoneAccepted": true,
        "avatar": {
          "href": "avatars/lav5d8de21d89971646555094.png"
        }
      }
    }
  ]
}