ACacculynx
contacts

[DRAFT] Get Contact Note by ID

Changed on

[DRAFT] Retrieves a Note associated with a specific contact.

Behavior:

  • Returns 200 with the note found in the contact
  • Returns 400 if any Query String parameter (contactId, noteId) doesn't fulfill the validations
  • Returns 404 if the contactId or noteId does not exist
  • Returns 500 if an internal error occurs.
get/contacts/{contactId}/notes/{noteId}

Request

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

Path parameters

contactIdstring uuid required

The contact's unique identifier

noteIdstring uuid required

The note's unique identifier

Response

OK

idstring uuid

The note's unique ID.

_linkstring

Use this URI to perform GET operations on the individual note resource. This link follows the pattern: /v2/contacts/{contactId}/notes/{noteId}

notestring

A text with the note.

createdDatestring date-time

The DateTime when the note was created. An ISO 8601 string of datetime including the time component and ending with 'Z' (so in UTC). https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)

updatedDatestring date-time

The DateTime when the note was updated. An ISO 8601 string of datetime including the time component and ending with 'Z' (so in UTC). https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)

Example response

{
  "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": "Text from the note.",
  "createdDate": "2026-03-25T09:30:00Z",
  "createdBy": {
    "id": "228db892-3b49-4455-b839-ffd8576d8731",
    "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
  },
  "updatedDate": "2026-03-26T09:30:00Z",
  "updatedBy": {
    "id": "228db892-3b49-4455-b839-ffd8576d8731",
    "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
  }
}

Changes