List Scheduled Activities API

Audience: Developers and Solution Architects

Purpose: Enables you to retrieve, inspect, and synchronize upcoming scheduled Activities at scale.

Overview

Use the List Scheduled Activities endpoint to retrieve a list of your Scheduled Activities, which represent planned future interactions that have not yet been logged or completed. Scheduled Activities represent upcoming work such as calls, meetings, tasks, or custom Activity types and are commonly used for planning, calendar views, reminders, and operational workflows.

This endpoint is designed for overview and discovery use cases, allowing external systems to surface upcoming Activities, filter by date or owner, and synchronize schedules at scale.

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

Note: This API provides a full list of all your Scheduled Activities without details. To retrieve full details for a single Scheduled Activity, check out Retrieve Scheduled Activity Details by ID API.

Why Would I Use this API?

You can use the Listing Scheduled Activities APIs when you need to:

• Display upcoming Activities in external applications, calendars, or task views

• Synchronize Activity schedules with external planning or calendar systems

• Drive reminders or notifications based on future work

• Support planning, workload management, or operational workflows

• Distinguish Scheduled Activities from Logged Activities

List Scheduled Activities API Behavior

Use this endpoint to retrieve Scheduled Activities and evaluate their current planned state within the platform. It:

• Returns Scheduled Activities based on their current status

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

• Maintains a Scheduled state until the Activity is logged

• Transitions the Activity to Completed when it is logged

• May trigger an activity.completed webhook when a Scheduled Activity is completed

• Includes completion metadata such as completed_at and logged_activity_id when applicable

• Returns response objects structured according to the Activities Data Model schema

---

List Scheduled Activities Endpoint

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

get

List Scheduled Activities

Authorizations

apiKey & businessId & userId

X-API-KEYstringRequired

X-BUSINESS-IDstringRequired

X-USER-IDstringRequired

Query parameters

assigned_to_mebooleanOptional

Filter Scheduled Activities assigned to the logged in employee

Example: {"value":"True","summary":"Example 1"}

completedbooleanOptional

Filter Scheduled Activities that have had a logged activity

Example: {"value":"True","summary":"Example 1"}

from_datestring · dateOptional

Filter Scheduled Activities Due Datetime starting from date

Example: {"value":"2022-01-23","summary":"Example 1"}

orderingstringOptional

Order Scheduled Activities by field. The negative sign in front of the '-activity_object' indicates descending order

Example: {"value":"employee","summary":"Orders by Employees full name"}

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

searchstringOptional

to_datestring · dateOptional

Filter Scheduled Activities Due Datetime ending on date

Example: {"value":"2022-02-27","summary":"Example 1"}

Responses

200Success

application/json

get

/api/activities/scheduled-activity

HTTPcURLJavaScriptPython

GET /api/activities/scheduled-activity HTTP/1.1
X-API-KEY: YOUR_API_KEY
X-BUSINESS-ID: YOUR_API_KEY
X-USER-ID: YOUR_API_KEY
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "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-03-04T03:53:14.405Z",
      "original_due_datetime": "2026-03-04T03:53:14.405Z",
      "completed_at": "2026-03-04T03:53:14.405Z",
      "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-03-04T03:53:14.405Z",
      "access": {
        "view": true,
        "edit": true,
        "remove": true
      }
    }
  ],
  "errors": [
    "error message"
  ]
}

List Scheduled Activities Schema

---

What’s Next?

After retrieving scheduled Activities via the API, you can:

• Display upcoming work in external applications or calendar views

• Retrieve full details for a specific scheduled Activity by ID

• Monitor when scheduled Activities transition into logged Activities

• Use scheduled Activity data in automations or workflows that depend on timing

For more information on scheduled and 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