View Logged Activity Details API

Audience: Developers and Solution Architects

Purpose: Enables programmatic logging of Activities in Kizen with clear, accurate, modern API documentation.

Overview

Use the View Logged Activity Details endpoint allows you to retrieve the full details of a logged Activity by its unique ID, providing access to metadata, associations, and submitted field values captured at the time the Activity was logged.

The material on this page builds on information covered on the Activities Core Concepts and Activities Data Model.

Why Would I Use this API?

You can use the Logged Activity retrieval API when you need to:

• Validate that an Activity was logged correctly

• Synchronize completed Activity data with external systems

• Support audit, compliance, or reporting workflows

• Debug integrations or automations that log Activities

• Retrieve submitted field values for downstream processing

View Logged Activity Details API Behavior

Use this endpoint to create and retrieve logged Activities that represent completed interactions within the platform. It:

• Returns a unique logged Activity ID that can be used for future retrieval

• Includes Activity type metadata, timestamps, the logging user, and associated Records

• Returns structured field values in fields[] when present, with value formats varying by field type

• Populates scheduled_activity_id when the logged Activity originated from a scheduled Activity; otherwise returns null

• Includes completion metadata, where completed_at is populated only when explicitly marked as completed

• Sets logged_at to the record creation timestamp, which reflects when the Activity was logged and appears in the UI

• Sets completed_at to the completion timestamp from the associated scheduled Activity when applicable

---

View Logged Activity Details Endpoint

Want to try the API out? Visit our Swagger docs.

get

Get logged activity record by ID

Authorizations

apiKey & businessId & userId

X-API-KEYstringRequired

X-BUSINESS-IDstringRequired

X-USER-IDstringRequired

Path parameters

idstring · uuidRequired

A UUID string identifying this logged activity record.

Responses

200Success

application/json

idstring · uuidRequired

notesstringRequired

logged_atstring · date-timeRequired

completed_atstring · date-time · nullableRead-onlyRequired

scheduled_activity_idstring · uuid · nullableRead-onlyRequired

mentionsstring · uuid[]Read-onlyRequired

get

/api/activities/logged/{id}

HTTPcURLJavaScriptPython

GET /api/activities/logged/{id} HTTP/1.1
X-API-KEY: YOUR_API_KEY
X-BUSINESS-ID: YOUR_API_KEY
X-USER-ID: YOUR_API_KEY
Accept: */*

200Success

{
  "fields": [
    {
      "value": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "field_type": "text",
      "custom_field_type": "text",
      "name": "text",
      "display_name": "text"
    }
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "notes": "text",
  "activity_object": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "api_name": "text",
    "association_mode": "text"
  },
  "associated_entities": [
    {
      "custom_object_id": "123e4567-e89b-12d3-a456-426614174000",
      "object_name": "text",
      "entity_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "display_name": "text",
      "custom_object_name": "text",
      "object_api_name": "text"
    }
  ],
  "logged_at": "2026-03-04T04:22:42.582Z",
  "logged_by": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "full_name": "text",
    "display_name": "text",
    "email": "[email protected]",
    "deleted": true
  },
  "completed_at": "2026-03-04T04:22:42.582Z",
  "completed_by": {
    "picture_url": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "first_name": "text",
    "last_name": "text",
    "email": "[email protected]",
    "display_name": "text"
  },
  "scheduled_activity_id": "123e4567-e89b-12d3-a456-426614174000",
  "mentions": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

View Logged Activity Details Schema

---

What's Next?

After retrieving logged Activities via the API, you can:

• Validate or audit completed Activities

• Synchronize logged Activity data with external systems

• Use logged Activities in reporting, analytics, or downstream workflows

For more information on logged Activities, check out the following topics below:

Related Topics

• Activities

• Activities Core Concepts

• Activities Data Model

• Activity Permissions

• Advanced Activity Rules

• Activities API & Webhooks