Retrieving Scheduled Activity Details by ID

Audience: Technical Builders, Implementors, and Developers

Purpose: Enables you to retrieve the full details of a single scheduled Activity by ID using the Kizen API.

Overview

Use this endpoint to fetch the complete details of a single scheduled Activity using its unique identifier. This includes scheduling information, ownership, associations, notes, and completion metadata needed to fully understand or act on a specific planned Activity.

This endpoint is designed for detail-oriented use cases, such as inspecting a selected scheduled Activity after discovery, validating scheduling state or timing, or retrieving authoritative data for synchronization, troubleshooting, or automation workflows.

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

Note: This API pulls the details of only one Activity by ID. To retrieve a full list of all your scheduled Activities without details, check out Listing Scheduled Activities via API.

Why Would I Use This API?

You can use the Retrieve Scheduled Activity Details by ID API when you need to:

• Retrieve the complete, authoritative details for a single scheduled Activity by ID

• Inspect scheduling metadata, ownership, associations, and notes for a selected logged activity

• Confirm whether a scheduled Activity is still upcoming or has been completed and logged

• Synchronize a known scheduled Activity with external systems after discovery

• Validate scheduling state or timing for troubleshooting, automation, or reconciliation workflows

• Follow the transition of a scheduled Activity into a logged Activity using completion metadata

Scheduled Activity Details API Behavior

This endpoint returns a single scheduled Activity based on its current planned state

• Scheduled Activities appear in the UI as upcoming tasks based on their due_datetime

• A scheduled Activity remains in a Scheduled state until it is completed and logged

• When a scheduled Activity is completed, it may trigger an activity.completed webhook

• Once completed, the scheduled Activity is marked as Completed and includes completion metadata such as completed_at and logged_activity_id

• The response structure follows the schemas defined in the Activities Data Model, ensuring consistency with other Activities APIs

---

Retrieve Scheduled Activity Details by ID Endpoint

Want to try this endpoint out? Visit our Swagger docs.

get

Get scheduled activity record by ID

Authorizations

businessId & userId & apiKey

X-BUSINESS-IDstringRequired

X-USER-IDstringRequired

X-API-KEYstringRequired

Path parameters

idstringRequiredPattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Responses

200Success

application/json

get

/api/activities/scheduled-activity/{id}

HTTPcURLJavaScriptPython

GET /api/activities/scheduled-activity/{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

{
  "associated_entities": [
    {
      "custom_object": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "object_name": "text"
      },
      "entity": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "email": "text",
        "display_name": "text"
      }
    }
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "note": "text",
  "due_datetime": "2026-01-17T14:06:33.371Z",
  "original_due_datetime": "2026-01-17T14:06:33.371Z",
  "completed_at": "2026-01-17T14:06:33.371Z",
  "logged_activity_id": "123e4567-e89b-12d3-a456-426614174000",
  "activity_object": "text",
  "employee": "text",
  "role": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "default_for_new_users": true
  },
  "mentions": {
    "picture_url": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "first_name": "text",
    "last_name": "text",
    "email": "[email protected]",
    "display_name": "text"
  },
  "associated_fields": "text",
  "notifications": "text",
  "created": "2026-01-17T14:06:33.371Z",
  "access": {
    "view": true,
    "edit": true,
    "remove": true
  }
}

Retrieve Scheduled Activity Details by ID Schema

---

What’s Next?

After retrieving a specific scheduled Activity via the API, you can:

• Display detailed upcoming work in external applications or calendar views

• Confirm scheduling, ownership, or association details for a specific Activity

• Monitor when a scheduled Activity transitions into a logged Activity

• Use scheduled Activity data in time-based automations or workflows

For more information on scheduled and logged Activities, review the related topics below.