> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Salesloft: Calendar Events With Recurring Index

> List the calendar events of Salesloft users within a date range, with each recurring occurrence expanded. Includes SDK V2 examples, schemas, and cost.

List the calendar events of Salesloft users within a date range, with each recurring occurrence expanded.

> [!NOTE]
>
> Tool ID: `salesloft_calendar_events_with_recurring_index`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'salesloft_calendar_events_with_recurring_index',
  {
    "start_time": "example",
    "end_time": "example"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute salesloft_calendar_events_with_recurring_index --input '{
  "start_time": "example",
  "end_time": "example"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": [
    {
      "meeting_link": "example",
      "is_performed_by_organizer": true,
      "organizer": "example"
    }
  ]
}
```

Use `deepline describe salesloft_calendar_events_with_recurring_index --json` for the latest machine-readable contract.

## Input reference

Returns all calendar events including expanded recurring event occurrences, paginated and filtered by date. This endpoint includes performance optimizations for handling recurring events efficiently.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.per_page` | `integer` | No | — | How many records to show per page in the range \[1, 100]. Defaults to 25 |
| `payload.page` | `integer` | No | — | The current page to fetch results from. Defaults to 1 |
| `payload.include_paging_counts` | `boolean` | No | — | Whether to include total\_pages and total\_count in the metadata. Defaults to false |
| `payload.sort_by` | `string` | No | — | Key to sort on, must be one of: start\_time. Defaults to start\_time |
| `payload.sort_direction` | `string` | No | — | Direction to sort in, must be one of: ASC, DESC. Defaults to DESC |
| `payload.start_time` | `string` | Yes | — | Lower bound (inclusive) for a calendar event's end time to filter by. Must be in ISO 8601 format. Example: `2022-02-14T10:12:59+00:00`. |
| `payload.end_time` | `string` | Yes | — | Upper bound (exclusive) for a calendar event's start time to filter by. Must be in ISO 8601 format. Example: `2022-02-14T10:12:59+00:00`. |
| `payload.user_guid` | `string` | No | — | user\_guid of the user who created or included as a guest to the event. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Returns all calendar events including expanded recurring event occurrences, paginated and filtered by date. This endpoint includes performance optimizations for handling recurring events efficiently.",
    "properties": {
      "per_page": {
        "type": "integer",
        "description": "How many records to show per page in the range [1, 100]. Defaults to 25"
      },
      "page": {
        "type": "integer",
        "description": "The current page to fetch results from. Defaults to 1"
      },
      "include_paging_counts": {
        "type": "boolean",
        "description": "Whether to include total_pages and total_count in the metadata. Defaults to false"
      },
      "sort_by": {
        "type": "string",
        "description": "Key to sort on, must be one of: start_time. Defaults to start_time"
      },
      "sort_direction": {
        "type": "string",
        "description": "Direction to sort in, must be one of: ASC, DESC. Defaults to DESC"
      },
      "start_time": {
        "type": "string",
        "description": "Lower bound (inclusive) for a calendar event's end time to filter by. Must be in ISO 8601 format. Example: `2022-02-14T10:12:59+00:00`."
      },
      "end_time": {
        "type": "string",
        "description": "Upper bound (exclusive) for a calendar event's start time to filter by. Must be in ISO 8601 format. Example: `2022-02-14T10:12:59+00:00`."
      },
      "user_guid": {
        "type": "string",
        "description": "user_guid of the user who created or included as a guest to the event."
      }
    },
    "required": [
      "start_time",
      "end_time"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `array` | Yes | — | Provider response payload. |
| `result.data[].meeting_link` | `string` | No | — | The meeting join URL (e.g. Google Meet or Microsoft Teams link), if available. |
| `result.data[].is_performed_by_organizer` | `boolean` | No | — | Whether the action on this calendar event was performed by the organizer of the event. False when a non-organizer attendee removes the event from their calendar (e.g. 'this and following' decline). |
| `result.data[].organizer` | `string` | No | — | The organizer email of the calendar event. |
| `result.data[].end_time` | `string` | No | — | The (exclusive) end time of the calendar event. Format: `date-time`. |
| `result.data[].attendees` | `array` | No | — | The attendees of the calendar event. |
| `result.data[].all_day` | `boolean` | No | — | Whether the calendar event is an all-day event. |
| `result.data[].busy` | `boolean` | No | — | Busy/free status of the calendar event |
| `result.data[].body_html` | `string` | No | — | Raw body content from Microsoft calendar events |
| `result.data[].recurring` | `boolean` | No | — | Whether the calendar event is a recurring event. |
| `result.data[].series_master_event_id` | `string` | No | — | INTERNAL: The ID of the recurring event series master event. This field is omitted for single events or instances of recurring events. |
| `result.data[].created_at` | `string` | No | — | Creation time of the calendar event. Format: `date-time`. |
| `result.data[].location` | `string` | No | — | Location of the calendar event |
| `result.data[].status` | `string` | No | — | The status of the calendar event. It can be empty for non-google events. |
| `result.data[].start_time` | `string` | No | — | The (inclusive) start time of the calendar event. Format: `date-time`. |
| `result.data[].previous_values` | `record` | No | — | Previous values of the calendar event fields before the last update. |
| `result.data[].updated_at` | `string` | No | — | Last modification time of the calendar event. Format: `date-time`. |
| `result.data[].conference_data` | `record` | No | — | The conference-related information, such as details of a Google Meet conference. |
| `result.data[].canceled_at` | `string` | No | — | The canceled date of the calendar event. Format: `date-time`. |
| `result.data[].creator` | `string` | No | — | The creator email of the calendar event. |
| `result.data[].tenant_id` | `integer` | No | — | Tenant ID of the user calendar |
| `result.data[].recurring_interval` | `string` | No | — | Specifies how often a recurring event repeats (Daily, Weekly, Monthly, Yearly). This field is omitted for single events or instances of recurring events. |
| `result.data[].out_of_office_properties` | `record` | No | — | Out-of-office properties for Google Calendar out-of-office events. Contains decline message and auto decline mode. |
| `result.data[].html_link` | `string` | No | — | An absolute link to this calendar event in the Google Calendar Web UI. |
| `result.data[].recurrence` | `array` | No | — | List of RRULE for a recurring event, as specified in RFC5545. This field is omitted for single events or instances of recurring events. |
| `result.data[].description` | `string` | No | — | Description of the calendar event |
| `result.data[].calendar_id` | `string` | No | — | Calendar ID of the user calendar. |
| `result.data[].provider` | `string` | No | — | The provider of the calendar event. |
| `result.data[].id` | `string` | No | — | The calendar event original ID from calendar provider |
| `result.data[].extended_properties` | `record` | No | — | Extended properties of the calendar event. |
| `result.data[].i_cal_uid` | `string` | No | — | Calendar event unique identifier (iCalUID) |
| `result.data[].user_guid` | `string` | No | — | User GUID of the user calendar. |
| `result.data[].title` | `string` | No | — | Title of the calendar event |
| `result.data[].last_occurrence_at` | `string` | No | — | The timestamp of the last occurrence in a series of recurring events. Format: `date-time`. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "array",
        "description": "Provider response payload.",
        "items": {
          "type": "object",
          "properties": {
            "meeting_link": {
              "type": "string",
              "description": "The meeting join URL (e.g. Google Meet or Microsoft Teams link), if available."
            },
            "is_performed_by_organizer": {
              "type": "boolean",
              "description": "Whether the action on this calendar event was performed by the organizer of the event. False when a non-organizer attendee removes the event from their calendar (e.g. 'this and following' decline)."
            },
            "organizer": {
              "type": "string",
              "description": "The organizer email of the calendar event."
            },
            "end_time": {
              "type": "string",
              "description": "The (exclusive) end time of the calendar event.",
              "format": "date-time"
            },
            "attendees": {
              "type": "array",
              "description": "The attendees of the calendar event.",
              "items": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            },
            "all_day": {
              "type": "boolean",
              "description": "Whether the calendar event is an all-day event."
            },
            "busy": {
              "type": "boolean",
              "description": "Busy/free status of the calendar event"
            },
            "body_html": {
              "type": "string",
              "description": "Raw body content from Microsoft calendar events"
            },
            "recurring": {
              "type": "boolean",
              "description": "Whether the calendar event is a recurring event."
            },
            "series_master_event_id": {
              "type": "string",
              "description": "INTERNAL: The ID of the recurring event series master event. This field is omitted for single events or instances of recurring events."
            },
            "created_at": {
              "type": "string",
              "description": "Creation time of the calendar event.",
              "format": "date-time"
            },
            "location": {
              "type": "string",
              "description": "Location of the calendar event"
            },
            "status": {
              "type": "string",
              "description": "The status of the calendar event. It can be empty for non-google events."
            },
            "start_time": {
              "type": "string",
              "description": "The (inclusive) start time of the calendar event.",
              "format": "date-time"
            },
            "previous_values": {
              "type": "object",
              "description": "Previous values of the calendar event fields before the last update."
            },
            "updated_at": {
              "type": "string",
              "description": "Last modification time of the calendar event.",
              "format": "date-time"
            },
            "conference_data": {
              "type": "object",
              "description": "The conference-related information, such as details of a Google Meet conference."
            },
            "canceled_at": {
              "type": "string",
              "description": "The canceled date of the calendar event.",
              "format": "date-time"
            },
            "creator": {
              "type": "string",
              "description": "The creator email of the calendar event."
            },
            "tenant_id": {
              "type": "integer",
              "description": "Tenant ID of the user calendar"
            },
            "recurring_interval": {
              "type": "string",
              "description": "Specifies how often a recurring event repeats (Daily, Weekly, Monthly, Yearly). This field is omitted for single events or instances of recurring events."
            },
            "out_of_office_properties": {
              "type": "object",
              "description": "Out-of-office properties for Google Calendar out-of-office events. Contains decline message and auto decline mode."
            },
            "html_link": {
              "type": "string",
              "description": "An absolute link to this calendar event in the Google Calendar Web UI."
            },
            "recurrence": {
              "type": "array",
              "description": "List of RRULE for a recurring event, as specified in RFC5545. This field is omitted for single events or instances of recurring events.",
              "items": {
                "type": "string"
              }
            },
            "description": {
              "type": "string",
              "description": "Description of the calendar event"
            },
            "calendar_id": {
              "type": "string",
              "description": "Calendar ID of the user calendar."
            },
            "provider": {
              "type": "string",
              "description": "The provider of the calendar event."
            },
            "id": {
              "type": "string",
              "description": "The calendar event original ID from calendar provider"
            },
            "extended_properties": {
              "type": "object",
              "description": "Extended properties of the calendar event."
            },
            "i_cal_uid": {
              "type": "string",
              "description": "Calendar event unique identifier (iCalUID)"
            },
            "user_guid": {
              "type": "string",
              "description": "User GUID of the user calendar."
            },
            "title": {
              "type": "string",
              "description": "Title of the calendar event"
            },
            "last_occurrence_at": {
              "type": "string",
              "description": "The timestamp of the last occurrence in a series of recurring events.",
              "format": "date-time"
            }
          },
          "additionalProperties": false
        }
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Salesloft provider guide](https://deepline.com/docs/providers/salesloft/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.