Calendar Entries (Tasks & Events)

List a calendar entry's sub-entries

Sub-tasks of a task, oldest first.

get/calendar_entries/{id}/sub_calendar_entries

Request

  • Base URL: https://api.pipelinecrm.com/api/v3
  • URL: https://api.pipelinecrm.com/api/v3/calendar_entries/{id}/sub_calendar_entries
  • 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

Path parameters

idinteger required

Calendar entry ID

Response

Successful Response

idinteger

Unique identifier

owner_idinteger
ownerobject

Convenience method to access the owner id and full name.

categoryobject nullable

Convenience object to access the category name for the entry.

completed_atstring nullable

Timestamp for when the complete flag was set to true

base_entry_idinteger nullable

If the event is part of a recurring series, this points to the base entry of the recurring series.

google_calendar_idstring nullable

This is no longer used, but provided for backwards compatibility purposes.

part_of_recurring_seriesboolean

Convenience method to see if an event is part of a recurring series.

recurrence_endstring nullable

Convenience method to get the recurrence end date

calendar_entry_priorityobject

Convenience object to access the priority name/color for the entry.

calendar_entry_statusobject

Convenience object to access the status name/color for the entry when calendar_entry_status_id is set.

created_atstring

Timestamp when the record was created (time zone in user's time zone).

updated_atstring

Timestamp when the record was last touched (time zone in user's time zone).

type'CalendarEvent' | 'CalendarTask'
category_idinteger nullable

The event category. You can retrieve a list of event categories using the event categories api.

namestring

The name of the tasks/event.

descriptionstring nullable

A more detailed description of the event.

start_timestring nullable

For CalendarEvent only. Specify the start_time for the event (time zone is user's time zone).

end_timestring nullable

For CalendarEvent only. Specify the end time for the event (time zone is user's time zone).

all_dayboolean

Specify if this event is all day. Defaults to false for Events, true for Tasks

due_datestring nullable

Tasks only. Specify the due date.

completeboolean
association_idinteger nullable

The id of the associated person, company, or deal

association_type'Deal' | 'Company' | 'Person' | 'null' nullable

The type of association

activeboolean

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_idinteger nullable

If this event is tied directly with a company, then this will be set to the company id.

rrulestring nullable

Specify an rrule to change the recurrence rule. This string follows the iCalendar spec, RFC2445.

rdatestring nullable

Specify an rdate to change the recurrence rule. This string follows the iCalendar spec, RFC2445.

exrulestring nullable

Specify an exrule to change the recurrence rule. This string follows the iCalendar spec, RFC2445.

exdatestring nullable

Specify an exdate to change the recurrence rule. This string follows the iCalendar spec, RFC2445.

calendar_entry_priority_idinteger nullable

The event priority. You can retrieve a list of event priorities using the event priorities api.

calendar_entry_status_idinteger nullable

The event status. You can retrieve a list of event statuses using the event statuses admin api.

Example response

[
  {
    "id": 5602,
    "owner_id": 13,
    "owner": {
      "id": 1,
      "full_name": "Bob Smith"
    },
    "category": {
      "id": 1,
      "name": "Phone call"
    },
    "calendar_entry_priority": {
      "id": 18,
      "name": "High",
      "hex_color": "ff0000",
      "position": 1
    },
    "calendar_entry_status": {
      "id": 2,
      "name": "In Progress",
      "hex_color": "#DEF7EC",
      "position": 2
    },
    "created_at": "2026-09-01 14:22:07",
    "updated_at": "2026-09-01 14:22:07",
    "type": "CalendarTask",
    "category_id": 2,
    "name": "Send revised quote",
    "description": "The meeting is at 3:30",
    "start_time": "2026-09-08 15:00:00",
    "end_time": "2026-09-08 15:30:00",
    "due_date": "2026-09-08",
    "association_id": 4521,
    "association_type": "Deal",
    "active": true,
    "company_id": 3310,
    "rrule": "FREQ=WEEKLY;BYDAY=TU",
    "calendar_entry_priority_id": 2,
    "calendar_entry_status_id": 2
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.