contacts

[DRAFT] Get Contact Notes

Changed on

[DRAFT] Retrieves a paginated list of all notes entries associated with a specific contact, sorted by createdDate in descending order (most recent first).

Pagination:

  • PageStartIndex: Zero-based index of the first record to return (default: 0)
  • PageSize: Number of records per page (default: 25, max: 100)
  • Both pagination parameters are optional

Behavior:

  • Returns 200 with an empty items array if the contact exists but has no notes
  • Returns 400 if any Query String parameter (contactId, pageSize, recordStartIndex) doesn't fulfill the validations
  • Returns 404 if the contactId does not exist
  • Returns 416 if recordStartIndex or pageSize are negative, or exceeds the maximum allowed
  • Returns 500 if an internal error occurs.
get/contacts/{contactId}/notes

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/contacts/{contactId}/notes
  • Auth
    HTTP bearer

Path parameters

contactIdstring uuid required

The contact's unique identifier

Query parameters

pageSizeinteger

How many items to be returned at a time.

recordStartIndexinteger

The zero-based index of the first record to return.

Response

OK

countinteger

The total number of items matching the current query.

pageSizeinteger

The requested or default page size.

pageStartIndexinteger

The requested or default index of the first element to return.

Example response

{
  "items": [
    {
      "id": "cf3987e6-24bc-4b34-91bb-e230cd4ea6d7",
      "_link": "https://api.acculynx.com/v2/contacts/61370abe-3534-4ba8-b2f2-2ff56cdd5e02/notes/cf3987e6-24bc-4b34-91bb-e230cd4ea6d7",
      "note": "Client called to check roof status.",
      "createdDate": "2026-03-25T09:30:00Z",
      "createdBy": {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "_link": "https://api.acculynx.com/v2/users/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      },
      "updatedDate": "2026-03-26T09:30:00Z",
      "updatedBy": {
        "id": "596e693d-c1e8-4288-b17c-d460a4ed9860",
        "_link": "https://api.acculynx.com/v2/users/596e693d-c1e8-4288-b17c-d460a4ed9860"
      }
    }
  ]
}

Changes