Viewing Logged Activity Details via API

Audience: Technical Builders, Implementors, and Developers

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

Overview

Logged Activities represent an authoritative record of completed interactions in Kizen. They are commonly used as inputs to reporting, integrations, and audit workflows.

The GET /api/activities/logged/{id} 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

Logged Activity API Behavior

• Logged Activities represent completed interactions and can be retrieved later using their unique logged Activity ID

• The response includes Activity type metadata, timestamps, the user who logged the Activity, and associated records

• Submitted structured field values are returned in fields[] when present. The fields[].value format varies by field type

• If a logged Activity originated from a scheduled Activity, scheduled_activity_id contains the scheduled Activity ID. Otherwise it is null

• Completion metadata is included. completed_at is only populated when the activity is explicitly marked as completed; otherwise, it will be null

• logged_at Always matches the time the activity record is created and is displayed on the Kizen UI. Logging an activity and creating the record are the same action, so this value reflects when the activity was logged.

• completed_at Reflects the completion timestamp from the associated scheduled activity, when applicable.

---

Logged Activity Endpoint

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

get

Get logged activity record by ID

Authorizations

businessId & userId & apiKey

X-BUSINESS-IDstringRequired

X-USER-IDstringRequired

X-API-KEYstringRequired

Path parameters

idstring · uuidRequired

A UUID string identifying this logged activity record.

Responses

200Success

application/json

get

/api/activities/logged/{id}

HTTPcURLJavaScriptPython

GET /api/activities/logged/{id} HTTP/1.1
Host: 
X-BUSINESS-ID: YOUR_API_KEY
X-USER-ID: YOUR_API_KEY
X-API-KEY: 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-01-17T13:51:30.235Z",
  "logged_by": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "full_name": "text",
    "display_name": "text",
    "email": "[email protected]",
    "deleted": true
  },
  "completed_at": "2026-01-17T13:51:30.235Z",
  "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"
  ]
}

Logging Activity 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