Events

Index Calendar Events

get/api/calendars/{calendar_public_id}/events

Request

  • Base URL: https://addcal.co
  • URL: https://addcal.co/api/calendars/{calendar_public_id}/events
  • Auth: none required

Query parameters

rangestring

Filter events by time range. Options: 'all', 'upcoming', 'past'

Example:upcoming
searchstring

Search events by title or internal name

Example:team meeting
calendarstring

Filter events by calendar ID

Example:cal_abc123
start_datestring

Filter events starting from this date (ISO 8601 format)

Example:2024-01-01T00:00:00Z
end_datestring

Filter events ending before this date (ISO 8601 format)

Example:2024-12-31T23:59:59Z
rsvpboolean

Only return events with RSVPs enabled (true) or disabled (false)

Example:true
invitesboolean

Only return events with calendar invites enabled (true) or disabled (false)

Example:true

Request body

range'all' | 'upcoming' | 'past'
searchstring

Must not be greater than 255 characters.

calendarstring

Must not be greater than 255 characters.

start_datestring

Must be a valid date.

end_datestring

Must be a valid date.

rsvp'1' | '0' | 'true' | 'false'
invites'1' | '0' | 'true' | 'false'

Example request

{
  "range": "upcoming",
  "search": "hevehqnloksobnelxetrskonw",
  "calendar": "hlmtgftyqoqvzfhzmaukt",
  "start_date": "2026-08-28T03:20:12",
  "end_date": "2026-08-28T03:20:12",
  "rsvp": "true",
  "invites": "true"
}

Response

Example response

{
  "data": [
    {
      "uid": "izypfqsyeoxh",
      "public_id": "evt_izypfqsyeoxh",
      "calendar_uid": "cal_49o2h4qqhaux",
      "short_link": null,
      "title": "Accusamus illum non maxime aspernatur.",
      "internal_name": null,
      "is_draft": false,
      "description": "<p>Quae qui qui blanditiis quisquam aut eum. Et ullam at a. Omnis soluta dolorem optio alias qui.</p>\n\n<p>Doloribus quia dolore consequatur. Rem est provident occaecati et consequatur recusandae ut. Explicabo repudiandae beatae explicabo. Praesentium architecto quod velit aut architecto.</p>",
      "location": "78358 Koch Brooks\nNorth Neoma, WA 03464",
      "is_all_day": true,
      "has_rsvp": false,
      "has_calendar_invites": false,
      "rsvp_limit": null,
      "is_recurring": false,
      "recurrence_rule": null,
      "recurrence_text": null,
      "date_start": "2026-08-23T09:22:57+00:00",
      "date_end": "2026-08-23T12:22:57+00:00",
      "timezone": null,
      "busy_type": null,
      "reminder_before": null,
      "date_range_formatted": "Sun, Aug 23, 2026 (all day)",
      "public_url": "http://addcal.co/e/izypfqsyeoxh",
      "embed_url": "http://addcal.co/e/izypfqsyeoxh",
      "location_url": null,
      "image_url": null,
      "timezone_readable": null,
      "calendar": {
        "uid": "49o2h4qqhaux",
        "public_id": "cal_49o2h4qqhaux",
        "short_link": null,
        "name": "culpa sint fugit",
        "internal_name": "commodi delectus dolorem",
        "description": "",
        "timezone": "America/Santo_Domingo",
        "week_begins": 1,
        "public_url": "http://addcal.co/c/49o2h4qqhaux",
        "created_at": "2026-08-28T03:20:12.000000Z",
        "updated_at": "2026-08-28T03:20:12.000000Z"
      },
      "created_at": "2026-08-28T03:20:12.000000Z",
      "updated_at": "2026-08-28T03:20:12.000000Z"
    },
    {
      "uid": "qtre0reodap9",
      "public_id": "evt_qtre0reodap9",
      "calendar_uid": "cal_zlbtxo9tw4e7",
      "short_link": null,
      "title": "Tenetur adipisci est cupiditate excepturi consectetur.",
      "internal_name": null,
      "is_draft": false,
      "description": "<p>Quas cupiditate voluptatem dolores officia. Sunt itaque aut voluptatum ipsum amet ut possimus. Debitis eos tenetur sed doloremque atque eligendi asperiores. Possimus suscipit officiis omnis ab velit tempore a.</p>\n\n<p>Maiores ut quae molestias. Voluptatem nisi adipisci beatae maxime fugit et qui. Nam natus unde magnam nisi perferendis. Repudiandae totam sint sed autem accusantium.</p>",
      "location": null,
      "is_all_day": true,
      "has_rsvp": false,
      "has_calendar_invites": false,
      "rsvp_limit": null,
      "is_recurring": false,
      "recurrence_rule": null,
      "recurrence_text": null,
      "date_start": "2026-09-15T06:22:07+00:00",
      "date_end": "2026-09-15T08:22:07+00:00",
      "timezone": null,
      "busy_type": null,
      "reminder_before": null,
      "date_range_formatted": "Tue, Sep 15, 2026 (all day)",
      "public_url": "http://addcal.co/e/qtre0reodap9",
      "embed_url": "http://addcal.co/e/qtre0reodap9",
      "location_url": null,
      "image_url": null,
      "timezone_readable": null,
      "calendar": {
        "uid": "zlbtxo9tw4e7",
        "public_id": "cal_zlbtxo9tw4e7",
        "short_link": null,
        "name": "recusandae aut cum",
        "internal_name": null,
        "description": "<p>Odit sit quo pariatur sunt ut dolores et. Dolor repellat alias nemo. Beatae quia rerum esse veniam sed. Enim ut autem ut doloremque sed.</p>",
        "timezone": "Atlantic/Reykjavik",
        "week_begins": 5,
        "public_url": "http://addcal.co/c/zlbtxo9tw4e7",
        "created_at": "2026-08-28T03:20:12.000000Z",
        "updated_at": "2026-08-28T03:20:12.000000Z"
      },
      "created_at": "2026-08-28T03:20:12.000000Z",
      "updated_at": "2026-08-28T03:20:12.000000Z"
    }
  ]
}

Changes

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