Events

Index All Events

get/api/events

Request

  • Base URL: https://addcal.co
  • URL: https://addcal.co/api/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": "past",
  "search": "ffwng",
  "calendar": "yhez",
  "start_date": "2026-08-28T03:20:12",
  "end_date": "2026-08-28T03:20:12",
  "rsvp": "true",
  "invites": "true"
}

Response

Example response

{
  "data": [
    {
      "uid": "2497uth7f3zn",
      "public_id": "evt_2497uth7f3zn",
      "calendar_uid": "cal_eox0hmwyeu5k",
      "short_link": null,
      "title": "Sunt fugit tempore natus ducimus quae ut dolorum.",
      "internal_name": null,
      "is_draft": false,
      "description": "<p>Ducimus aut ab assumenda magnam labore consequuntur. Et est ea harum est et. Suscipit similique numquam incidunt consequatur. In nisi ut eveniet unde rerum est molestiae.</p>\n\n<p>Tenetur odio occaecati dolores. Labore quisquam sequi inventore voluptatem voluptatem totam. Consectetur nihil et possimus deserunt animi magnam dolorem. Et unde tenetur similique nam.</p>",
      "location": "342 Daugherty Mount\nSipesland, NE 37279-0492",
      "is_all_day": false,
      "has_rsvp": false,
      "has_calendar_invites": false,
      "rsvp_limit": null,
      "is_recurring": false,
      "recurrence_rule": null,
      "recurrence_text": null,
      "date_start": "2026-09-18T13:46:51+01:00",
      "date_end": "2026-09-18T16:46:51+01:00",
      "timezone": "Atlantic/Madeira",
      "busy_type": null,
      "reminder_before": null,
      "date_range_formatted": "Fri, Sep 18, 2026 1:46 PM - 4:46 PM",
      "public_url": "http://addcal.co/e/2497uth7f3zn",
      "embed_url": "http://addcal.co/e/2497uth7f3zn",
      "location_url": null,
      "image_url": null,
      "timezone_readable": "WEST / GMT+01:00",
      "calendar": {
        "uid": "eox0hmwyeu5k",
        "public_id": "cal_eox0hmwyeu5k",
        "short_link": null,
        "name": "aut beatae commodi",
        "internal_name": "consequatur sint voluptatem",
        "description": "",
        "timezone": "America/Santarem",
        "week_begins": 4,
        "public_url": "http://addcal.co/c/eox0hmwyeu5k",
        "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": "ap3xucsxrxyj",
      "public_id": "evt_ap3xucsxrxyj",
      "calendar_uid": "cal_ndi7c217vncr",
      "short_link": null,
      "title": "Modi esse est consequatur est et quibusdam laborum.",
      "internal_name": null,
      "is_draft": false,
      "description": "<p>Optio eius qui quod ut non. Et porro sapiente earum. Id hic reprehenderit amet nihil quasi.</p>\n\n<p>Provident exercitationem earum illo minus aspernatur ut et. Esse aspernatur sunt rerum rerum reiciendis maiores. Rem in illum est quis.</p>",
      "location": "257 Spinka Forks\nToniberg, SD 00015",
      "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-03T20:53:42+00:00",
      "date_end": "2026-08-03T22:53:42+00:00",
      "timezone": null,
      "busy_type": null,
      "reminder_before": null,
      "date_range_formatted": "Mon, Aug 3, 2026 (all day)",
      "public_url": "http://addcal.co/e/ap3xucsxrxyj",
      "embed_url": "http://addcal.co/e/ap3xucsxrxyj",
      "location_url": null,
      "image_url": null,
      "timezone_readable": null,
      "calendar": {
        "uid": "ndi7c217vncr",
        "public_id": "cal_ndi7c217vncr",
        "short_link": null,
        "name": "eveniet debitis voluptates",
        "internal_name": "voluptates nostrum ex",
        "description": "",
        "timezone": "Africa/Porto-Novo",
        "week_begins": 0,
        "public_url": "http://addcal.co/c/ndi7c217vncr",
        "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.