---
title: "Retrieve calendar entry"
method: GET
path: "/calendar_entries/{id}"
tags: ["Calendar Entries (Tasks & Events)"]
---

# Retrieve calendar entry

`GET /calendar_entries/{id}`

## Request

- Base URL: `https://api.pipelinecrm.com/api/v3`
- URL: `https://api.pipelinecrm.com/api/v3/calendar_entries/{id}`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer and API key in header `app-key`
  - API key in query parameter `api_key` and API key in query parameter `app_key`

To retrieve files attached to a calendar entry, use the `/documents` endpoint with the `calendar_entry_id` query parameter. See the [Files (Documents)](#tag/files-documents) section for more details.

## Path parameters

- `id` integer, required

## Response `200`

Successful Response

- CalendarEntryAll
  - `id` integer: Unique identifier
  - `owner_id` integer
  - `owner` object: Convenience method to access the owner id and full name.
  - `category` object, nullable: Convenience object to access the category name for the entry.
  - `completed_at` string, nullable: Timestamp for when the `complete` flag was set to `true`
  - `base_entry_id` integer, nullable: If the event is part of a recurring series, this points to the base entry of the recurring series.
  - `google_calendar_id` string, nullable: This is no longer used, but provided for backwards compatibility purposes.
  - `part_of_recurring_series` boolean: Convenience method to see if an event is part of a recurring series.
  - `recurrence_end` string, nullable: Convenience method to get the recurrence end date
  - `calendar_entry_priority` object: Convenience object to access the priority name/color for the entry.
  - `calendar_entry_status` object: Convenience object to access the status name/color for the entry when calendar_entry_status_id is set.
  - `created_at` string: Timestamp when the record was created (time zone in user's time zone).
  - `updated_at` string: Timestamp when the record was last touched (time zone in user's time zone).
  - `type` 'CalendarEvent' | 'CalendarTask'
  - `category_id` integer, nullable: The event category. You can retrieve a list of event categories using the [event categories](#tag/event-categories) api.
  - `name` string: The name of the tasks/event.
  - `description` string, nullable: A more detailed description of the event.
  - `start_time` string, nullable: For `CalendarEvent` only. Specify the start_time for the event (time zone is user's time zone).
  - `end_time` string, nullable: For `CalendarEvent` only. Specify the end time for the event (time zone is user's time zone).
  - `all_day` boolean: Specify if this event is all day. Defaults to `false` for `Events`, `true` for `Tasks`
  - `due_date` string, nullable: Tasks only. Specify the due date.
  - `complete` boolean
  - `association_id` integer, nullable: The `id` of the associated person, company, or deal
  - `association_type` 'Deal' | 'Company' | 'Person' | 'null', nullable: The type of association
  - `active` boolean: Inactive events are functionally equivalent to deleted events. Events that are part of a series, when deleted by a user, are instead marked inactive.
  - `company_id` integer, nullable: If this event is tied directly with a company, then this will be set to the company id.
  - `rrule` string, nullable: Specify an rrule to change the recurrence rule. This string follows the iCalendar spec, RFC2445.
  - `rdate` string, nullable: Specify an rdate to change the recurrence rule. This string follows the iCalendar spec, RFC2445.
  - `exrule` string, nullable: Specify an exrule to change the recurrence rule. This string follows the iCalendar spec, RFC2445.
  - `exdate` string, nullable: Specify an exdate to change the recurrence rule. This string follows the iCalendar spec, RFC2445.
  - `calendar_entry_priority_id` integer, nullable: The event priority. You can retrieve a list of event priorities using the [event priorities](#tag/calendar-event-task-priorities) api.
  - `calendar_entry_status_id` integer, nullable: The event status. You can retrieve a list of event statuses using the [event statuses](#tag/calendar-event-task-statuses) admin api.

## Other responses

- `400`: The request could not be processed as sent (for example a malformed id or an unsupported combination of parameters).

---

[API](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api.md) · [All operations](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api/revisions/53ebfcc83597?raw)