> ## 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.

# Unipile: Get Calendar Event

> Get one calendar event by event_id. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get one calendar event by event\_id.

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

## 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(
  'unipile_get_calendar_event',
  {
    "account_id": "123456789",
    "event_id": "event_123",
    "calendar_id": "calendar_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute unipile_get_calendar_event --input '{
  "account_id": "123456789",
  "event_id": "event_123",
  "calendar_id": "calendar_123"
}' --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": {
    "object": "CalendarEvent",
    "id": "id_123",
    "calendar_id": "calendar_123",
    "created_at": "2026-01-15T12:00:00Z",
    "updated_at": "2026-01-15T12:00:00Z",
    "title": "VP of Engineering",
    "is_cancelled": true,
    "is_all_day": true,
    "is_attendees_list_hidden": true,
    "start": {
      "date_time": "2026-01-15T12:00:00Z",
      "time_zone": "example"
    },
    "end": {
      "date_time": "2026-01-15T12:00:00Z",
      "time_zone": "example"
    },
    "organizer": {
      "email": "jane.doe@example.com"
    },
    "visibility": "public",
    "transparency": "opaque",
    "event_type": "default"
  }
}
```

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

## Input reference

Retrieve the details of a calendar event.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.account_id` | `string` | Yes | — | The id of the account to use. |
| `payload.event_id` | `string` | Yes | — | The id of the wanted event. |
| `payload.calendar_id` | `string` | Yes | — | The id of calendar of the wanted event. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieve the details of a calendar event.",
    "properties": {
      "account_id": {
        "type": "string",
        "description": "The id of the account to use."
      },
      "event_id": {
        "type": "string",
        "description": "The id of the wanted event."
      },
      "calendar_id": {
        "type": "string",
        "description": "The id of calendar of the wanted event."
      }
    },
    "required": [
      "account_id",
      "event_id",
      "calendar_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.object` | `"CalendarEvent"` | Yes | — | Allowed: `CalendarEvent`. |
| `result.data.id` | `string` | Yes | — | The ID of the calendar event. |
| `result.data.ical_uid` | `string` | No | — | The iCalendar UID of the event, as defined in RFC5545. |
| `result.data.master_event_id` | `string` | No | — | If event instance, the ID of the master event. |
| `result.data.calendar_id` | `string` | Yes | — | The ID of the calendar the event belongs to. |
| `result.data.created_at` | `string` | Yes | — | The date the event was created. Uses ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ). |
| `result.data.updated_at` | `string` | Yes | — | The date the event was last updated. Uses ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ). |
| `result.data.title` | `string` | Yes | — | The title of the event. |
| `result.data.body` | `string` | No | — | The body of the event. |
| `result.data.location` | `string` | No | — | The location of the event. |
| `result.data.is_cancelled` | `boolean` | Yes | — | Is the event cancelled. |
| `result.data.is_all_day` | `boolean` | Yes | — | Is the event all day. |
| `result.data.is_attendees_list_hidden` | `boolean` | Yes | — | Is the attendees list hidden for attendees. |
| `result.data.attendees` | `array` | No | — | The attendees of the event. |
| `result.data.attendees[].email` | `string` | Yes | — | Email address of the attendee. |
| `result.data.attendees[].display_name` | `string` | No | — | Display name of the attendee. |
| `result.data.attendees[].comment` | `string` | No | — | The response comment of the attendee. |
| `result.data.attendees[].is_organizer` | `boolean` | Yes | — | Is the attendee the organizer of the event. |
| `result.data.attendees[].is_optional` | `boolean` | Yes | — | Is the attendee optional (based on type). |
| `result.data.attendees[].is_resource` | `boolean` | Yes | — | Is the attendee a resource (based on type). |
| `result.data.attendees[].type` | `"required" \| "optional" \| "resource"` | Yes | — | Type of the attendee. |
| `result.data.attendees[].response_status` | `"yes" \| "no" \| "maybe" \| "noreply"` | Yes | — | The response status of the attendee. `yes` if the invitation is accepted. `no` if the invitation is declined. `maybe` if the attendee is not sure. `noreply` if the invitation is pending. |
| `result.data.start` | `object` | Yes | — | The start date and time of the event. |
| `result.data.start.date_time` | `string` | Yes | — | The date and time. Uses ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ). |
| `result.data.start.time_zone` | `string` | Yes | — | The time zone of the date time. |
| `result.data.start.date` | `string` | Yes | — | The date. Uses ISO 8601 date format (YYYY-MM-DD). |
| `result.data.end` | `object` | Yes | — | The end date and time of the event. |
| `result.data.end.date_time` | `string` | Yes | — | The date and time. Uses ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ). |
| `result.data.end.time_zone` | `string` | Yes | — | The time zone of the date time. |
| `result.data.end.date` | `string` | Yes | — | The date. Uses ISO 8601 date format (YYYY-MM-DD). |
| `result.data.recurrence` | `array` | No | — | List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. |
| `result.data.organizer` | `object` | Yes | — | — |
| `result.data.organizer.email` | `string` | Yes | — | Email address of the organizer. |
| `result.data.organizer.display_name` | `string` | No | — | Display name of the organizer. |
| `result.data.conference` | `object` | No | — | — |
| `result.data.conference.provider` | `"google_meet" \| "zoom" \| "teams" \| "unknown"` | Yes | — | The conference provider. Allowed: `google_meet`, `zoom`, `teams`, `unknown`. |
| `result.data.conference.conference_id` | `string` | No | — | The provider-native conference ID. |
| `result.data.conference.url` | `string` | No | — | The conference URL. If not provided, it will automatically create a new conference (only teams and google\_meet available) |
| `result.data.visibility` | `"public" \| "private"` | Yes | — | The visibility of the event. |
| `result.data.transparency` | `"opaque" \| "transparent"` | Yes | — | The transparency of the event. `opaque` does block time on the calendar and is equivalent to setting Show me as to Busy in the Calendar UI. `transparent` does not block time on the calendar and is equivalent to setting Show me as to Available in the Calendar UI. |
| `result.data.event_type` | `string` | Yes | `"default"` | The type of the event (`birthday`, `fromGmail`, `outOfOffice`...) |
| `result.data.guests_can_modify` | `boolean` | No | `false` | If true, allow guests to modify the event. `Outlook Calendar`: Not supported, this parameter will always be false. |
| `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": "object",
        "description": "Provider response payload.",
        "properties": {
          "object": {
            "type": "string",
            "enum": [
              "CalendarEvent"
            ]
          },
          "id": {
            "type": "string",
            "description": "The ID of the calendar event."
          },
          "ical_uid": {
            "type": "string",
            "description": "The iCalendar UID of the event, as defined in RFC5545."
          },
          "master_event_id": {
            "type": "string",
            "description": "If event instance, the ID of the master event."
          },
          "calendar_id": {
            "type": "string",
            "description": "The ID of the calendar the event belongs to."
          },
          "created_at": {
            "type": "string",
            "description": "The date the event was created. Uses ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ)."
          },
          "updated_at": {
            "type": "string",
            "description": "The date the event was last updated. Uses ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ)."
          },
          "title": {
            "type": "string",
            "description": "The title of the event."
          },
          "body": {
            "type": "string",
            "description": "The body of the event."
          },
          "location": {
            "type": "string",
            "description": "The location of the event."
          },
          "is_cancelled": {
            "type": "boolean",
            "description": "Is the event cancelled."
          },
          "is_all_day": {
            "type": "boolean",
            "description": "Is the event all day."
          },
          "is_attendees_list_hidden": {
            "type": "boolean",
            "description": "Is the attendees list hidden for attendees."
          },
          "attendees": {
            "type": "array",
            "description": "The attendees of the event.",
            "items": {
              "type": "object",
              "description": "An attendee of a calendar event.",
              "properties": {
                "email": {
                  "type": "string",
                  "description": "Email address of the attendee."
                },
                "display_name": {
                  "type": "string",
                  "description": "Display name of the attendee."
                },
                "comment": {
                  "type": "string",
                  "description": "The response comment of the attendee."
                },
                "is_organizer": {
                  "type": "boolean",
                  "description": "Is the attendee the organizer of the event."
                },
                "is_optional": {
                  "type": "boolean",
                  "description": "Is the attendee optional (based on type)."
                },
                "is_resource": {
                  "type": "boolean",
                  "description": "Is the attendee a resource (based on type)."
                },
                "type": {
                  "description": "Type of the attendee.",
                  "anyOf": [
                    {
                      "type": "string",
                      "enum": [
                        "required"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "optional"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "resource"
                      ]
                    }
                  ]
                },
                "response_status": {
                  "description": "The response status of the attendee. `yes` if the invitation is accepted. `no` if the invitation is declined. `maybe` if the attendee is not sure. `noreply` if the invitation is pending.",
                  "anyOf": [
                    {
                      "type": "string",
                      "enum": [
                        "yes"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "no"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "maybe"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "noreply"
                      ]
                    }
                  ]
                }
              },
              "required": [
                "email",
                "is_organizer",
                "is_optional",
                "is_resource",
                "type",
                "response_status"
              ],
              "additionalProperties": false
            }
          },
          "start": {
            "description": "The start date and time of the event.",
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "date_time": {
                    "type": "string",
                    "description": "The date and time. Uses ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ)."
                  },
                  "time_zone": {
                    "type": "string",
                    "description": "The time zone of the date time."
                  }
                },
                "required": [
                  "date_time",
                  "time_zone"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "date": {
                    "type": "string",
                    "description": "The date. Uses ISO 8601 date format (YYYY-MM-DD)."
                  }
                },
                "required": [
                  "date"
                ],
                "additionalProperties": false
              }
            ]
          },
          "end": {
            "description": "The end date and time of the event.",
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "date_time": {
                    "type": "string",
                    "description": "The date and time. Uses ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ)."
                  },
                  "time_zone": {
                    "type": "string",
                    "description": "The time zone of the date time."
                  }
                },
                "required": [
                  "date_time",
                  "time_zone"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "date": {
                    "type": "string",
                    "description": "The date. Uses ISO 8601 date format (YYYY-MM-DD)."
                  }
                },
                "required": [
                  "date"
                ],
                "additionalProperties": false
              }
            ]
          },
          "recurrence": {
            "type": "array",
            "description": "List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545.",
            "items": {
              "type": "string"
            }
          },
          "organizer": {
            "type": "object",
            "properties": {
              "email": {
                "type": "string",
                "description": "Email address of the organizer."
              },
              "display_name": {
                "type": "string",
                "description": "Display name of the organizer."
              }
            },
            "required": [
              "email"
            ],
            "additionalProperties": false
          },
          "conference": {
            "type": "object",
            "properties": {
              "provider": {
                "type": "string",
                "description": "The conference provider.",
                "enum": [
                  "google_meet",
                  "zoom",
                  "teams",
                  "unknown"
                ]
              },
              "conference_id": {
                "type": "string",
                "description": "The provider-native conference ID."
              },
              "url": {
                "type": "string",
                "description": "The conference URL. If not provided, it will automatically create a new conference (only teams and google_meet available)"
              }
            },
            "required": [
              "provider"
            ],
            "additionalProperties": false
          },
          "visibility": {
            "description": "The visibility of the event.",
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "public"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "private"
                ]
              }
            ]
          },
          "transparency": {
            "description": "The transparency of the event. `opaque` does block time on the calendar and is equivalent to setting Show me as to Busy in the Calendar UI. `transparent` does not block time on the calendar and is equivalent to setting Show me as to Available in the Calendar UI.",
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "opaque"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "transparent"
                ]
              }
            ]
          },
          "event_type": {
            "type": "string",
            "description": "The type of the event (`birthday`, `fromGmail`, `outOfOffice`...)",
            "default": "default"
          },
          "guests_can_modify": {
            "type": "boolean",
            "description": "If true, allow guests to modify the event. `Outlook Calendar`: Not supported, this parameter will always be false.",
            "default": false
          }
        },
        "required": [
          "object",
          "id",
          "calendar_id",
          "created_at",
          "updated_at",
          "title",
          "is_cancelled",
          "is_all_day",
          "is_attendees_list_hidden",
          "start",
          "end",
          "organizer",
          "visibility",
          "transparency",
          "event_type"
        ],
        "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

* [Unipile provider guide](https://deepline.com/docs/providers/unipile/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.