Retrieve Scheduled Activity Details by ID API

Audience: Developers and Solution Architects

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

Overview

Use the Retrieve Scheduled Activity Details by ID 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 Agentic 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 List Scheduled Activities API.

Why Would I Use This API?

You can use the Retrieving 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

Retrieve Scheduled Activity Details by ID API Behavior

Use this endpoint to retrieve a single Scheduled Activity and evaluate its current planned state within the platform. It:

Returns a Scheduled Activity by its unique identifier
Displays the Scheduled Activity in the UI as an upcoming task based on due_datetime
Maintains a Scheduled state until the Activity is completed and logged
May trigger an activity.completed webhook when the Scheduled Activity is completed
Marks the Scheduled Activity as Completed and includes metadata such as completed_at and logged_activity_id once logged
Returns a response structured according to the Activities Data Model schema

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

X-API-KEYstringRequired

X-BUSINESS-IDstringRequired

X-USER-IDstringRequired

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

idstring · uuidRequired

notestringRequired

due_datetimestring · date-timeRequired

original_due_datetimestring · date-timeRequired

completed_atstring · date-timeRequired

logged_activity_idstring · uuidRequired

activity_objectstringRequired

employeestringRequired

associated_fieldsstringRequired

notificationsstringRequired

createdstring · date-timeRequired

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

GET /api/activities/scheduled-activity/{id} HTTP/1.1
X-API-KEY: YOUR_API_KEY
X-BUSINESS-ID: YOUR_BUSINESS_ID
X-USER-ID: YOUR_USER_ID
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-01T00:00:00.000Z",
  "original_due_datetime": "2026-01-01T00:00:00.000Z",
  "completed_at": "2026-01-01T00:00:00.000Z",
  "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": "name@gmail.com",
    "display_name": "text",
    "account_type": "text"
  },
  "associated_fields": "text",
  "notifications": "text",
  "created": "2026-01-01T00:00:00.000Z",
  "access": {
    "view": true,
    "edit": true,
    "remove": true
  }
}

Retrieve Scheduled Activity Details by ID APISchema

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:

PreviousList Scheduled Activities API

NextTriggering External Activity Workflows with Webhooks

Last updated 4 months ago

Was this helpful?