ACacculynx
contacts

[DRAFT] Get Contact Log

Changed on

[DRAFT] Retrieves a single contact log entry by its unique identifier for a specific contact.

get/contacts/{contactId}/logs/{logId}

Request

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

Path parameters

contactIdstring uuid required

The contact's unique identifier

logIdstring uuid required

The unique identifier (UUID) of the contact log entry to retrieve.

Response

OK

idstring uuid

The log's unique ID.

_linkstring

Use this URI to perform GET operations on the individual log resource. This link follows the pattern: /v2/contacts/{contactId}/logs/{logId}

logDatestring date-time

The DateTime for the log. 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)

type'PhoneCall' | 'SMS' | 'Email'

The Contact Log Type

descriptionstring nullable

A text with a description of the log.

createdDatestring date-time

The DateTime when the log 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)

Example response

{
  "id": "cf3987e6-24bc-4b34-91bb-e230cd4ea6d7",
  "_link": "https://api.acculynx.com/v2/contacts/61370abe-3534-4ba8-b2f2-2ff56cdd5e02/logs/cf3987e6-24bc-4b34-91bb-e230cd4ea6d7",
  "logDate": "2025-05-18T10:00:00Z",
  "type": "SMS",
  "description": "Client called to check roof status.",
  "createdDate": "2025-05-17T09:30:00Z",
  "createdBy": {
    "id": "228db892-3b49-4455-b839-ffd8576d8731",
    "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
  }
}

Changes