{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/addcal.co" } ], "info": { "name": "AddCal API Documentation", "_postman_id": "f8ca0649-c3e9-46e5-9b02-92d18ccc1513", "description": "The official AddCal API documentation. This comprehensive guide provides developers with everything needed to integrate calendar and event management functionality into their applications. Our RESTful API enables seamless creation, management, and sharing of events across multiple platforms and calendar services.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Create Event", "description": "A simplified endpoint for creating events with smart defaults and automatic calendar management.\n\nThis endpoint provides a streamlined way to create events by handling calendar creation and management automatically. It offers three ways to specify a calendar:\n1. Use an existing calendar by providing its `calendar_uid`\n2. Create or reuse a calendar by name using `calendar_name`\n3. Use a default calendar (automatically created if needed)\n\nKey features:\n- Automatic 1-hour duration if no end time is specified\n- Flexible team selection with smart defaults\n- Automatic calendar creation with sensible defaults\n- Timezone inheritance from calendar if not specified\n- Support for all-day events\n\nThe response includes the created event details along with calendar information and add-to-calendar links for various platforms.", "item": [ { "name": "POST api\/events", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/events", "query": [ { "key": "with_html", "value": "1", "description": "Include HTML variants for calendar links in the response", "disabled": false } ], "raw": "{{baseUrl}}\/api\/events?with_html=1" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Team Meeting\",\"description\":\"Monthly team sync to discuss project progress and upcoming milestones.\",\"location\":\"Conference Room A or https:\\\/\\\/zoom.us\\\/j\\\/123456789\",\"is_all_day\":false,\"is_virtual\":false,\"organiser_name\":\"Jane Smith\",\"organiser_email\":\"jane@example.com\",\"recurrence_rule\":\"FREQ=WEEKLY;BYDAY=MO;COUNT=10\",\"series_title\":\"Weekly Team Meeting\",\"has_rsvp\":false,\"date_start\":\"2024-03-25 14:00:00\",\"date_end\":\"2024-03-25 15:00:00\",\"timezone\":\"America\\\/New_York\",\"busy_type\":\"busy\",\"reminder_before\":30,\"short_link\":\"my-event\",\"team_uid\":\"team_abc123\",\"calendar_uid\":\"cal_xyz789\",\"calendar_name\":\"Team Meetings\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"uid\":\"rkpp3x41r8ih\",\"public_id\":\"evt_rkpp3x41r8ih\",\"calendar_uid\":\"cal_m9aokdxfmnhh\",\"short_link\":null,\"title\":\"Ut sequi magni vel dolorem id deleniti quia.\",\"internal_name\":null,\"is_draft\":false,\"description\":\"

Omnis beatae accusantium et quasi et. Quo aliquam quaerat qui in officiis omnis aliquam eaque. Aut sunt veritatis quis explicabo quidem doloremque. Aliquam aut consequuntur fuga exercitationem pariatur explicabo.<\\\/p>\\n\\n

Quia officiis asperiores debitis natus excepturi. Perspiciatis autem aut id provident. Voluptatum nesciunt optio reiciendis molestiae. Veritatis ut qui sed ea quisquam necessitatibus.<\\\/p>\",\"location\":\"285 Cassie Summit\\nGottliebville, MO 30606\",\"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-06T02:01:00-05:00\",\"date_end\":\"2026-09-06T03:01:00-05:00\",\"timezone\":\"America\\\/Chicago\",\"busy_type\":null,\"reminder_before\":null,\"date_range_formatted\":\"Sun, Sep 6, 2026 2:01 AM - 3:01 AM\",\"public_url\":\"http:\\\/\\\/addcal.co\\\/e\\\/rkpp3x41r8ih\",\"embed_url\":\"http:\\\/\\\/addcal.co\\\/e\\\/rkpp3x41r8ih\",\"location_url\":null,\"image_url\":null,\"timezone_readable\":\"CDT \\\/ GMT-05:00\",\"calendar\":{\"uid\":\"m9aokdxfmnhh\",\"public_id\":\"cal_m9aokdxfmnhh\",\"short_link\":null,\"name\":\"et alias optio\",\"internal_name\":null,\"description\":\"

Impedit mollitia corrupti corrupti repellat. Quia sunt distinctio illum voluptatum. Qui et esse voluptates pariatur.<\\\/p>\",\"timezone\":\"America\\\/Campo_Grande\",\"week_begins\":6,\"public_url\":\"http:\\\/\\\/addcal.co\\\/c\\\/m9aokdxfmnhh\",\"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\"},\"links\":{\"event_page\":\"http:\\\/\\\/addcal.co\\\/e\\\/rkpp3x41r8ih\",\"auto\":\"https:\\\/\\\/addcal.co\\\/e\\\/rkpp3x41r8ih\\\/auto\",\"google\":\"https:\\\/\\\/addcal.co\\\/e\\\/rkpp3x41r8ih\\\/google\",\"apple\":\"https:\\\/\\\/addcal.co\\\/e\\\/rkpp3x41r8ih\\\/apple\",\"outlook\":\"https:\\\/\\\/addcal.co\\\/e\\\/rkpp3x41r8ih\\\/outlook\",\"outlook_web\":\"https:\\\/\\\/addcal.co\\\/e\\\/rkpp3x41r8ih\\\/outlook_web\",\"yahoo\":\"https:\\\/\\\/addcal.co\\\/e\\\/rkpp3x41r8ih\\\/yahoo\",\"office365\":\"https:\\\/\\\/addcal.co\\\/e\\\/rkpp3x41r8ih\\\/office365\",\"ics\":\"https:\\\/\\\/addcal.co\\\/e\\\/rkpp3x41r8ih\\\/ics\"},\"html\":{\"single-button\":\"Add to Calendar Button\",\"icon-buttons-single-row\":\"Buttons With Icons\",\"icons\":\"Text with Icons\",\"dot-sep\":\"Text (dot separated)\",\"space-sep\":\"Text (space separated)\"}}", "name": "" }, { "header": [], "code": 409, "body": "{\"message\":\"You have reached your monthly event limit of 10. Please upgrade your plan to create more events.\",\"current\":10,\"limit\":10,\"remaining\":0,\"would_exceed_by\":1,\"is_unlimited\":false,\"limit_type\":\"monthly\"}", "name": "When the team's event limit has been exceeded" } ] } ] }, { "name": "Calendars", "description": "APIs for managing calendars", "item": [ { "name": "List Calendars", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars", "query": [], "raw": "{{baseUrl}}\/api\/calendars" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 200, "body": "{\"data\":[{\"uid\":\"p9v02qsz079d\",\"public_id\":\"cal_p9v02qsz079d\",\"short_link\":null,\"name\":\"Test RSVP Cal\",\"internal_name\":null,\"description\":\"\",\"timezone\":\"Australia\\\/Adelaide\",\"week_begins\":4,\"public_url\":\"https:\\\/\\\/addcal.co\\\/c\\\/p9v02qsz079d\",\"upcoming_events_count\":2,\"events_count\":72,\"created_at\":\"2025-07-27T06:43:09.000000Z\",\"updated_at\":\"2025-11-18T03:43:23.000000Z\"},{\"uid\":\"0vwbr1bxbjai\",\"public_id\":\"cal_0vwbr1bxbjai\",\"short_link\":null,\"name\":\"Test User's Calendar\",\"internal_name\":null,\"description\":\"

Professional meetings, webinars, and business events.<\\\/p>\",\"timezone\":\"Australia\\\/Sydney\",\"week_begins\":1,\"public_url\":\"https:\\\/\\\/addcal.co\\\/c\\\/0vwbr1bxbjai\",\"upcoming_events_count\":6,\"events_count\":8,\"created_at\":\"2025-07-29T23:32:49.000000Z\",\"updated_at\":\"2025-07-29T23:32:49.000000Z\"},{\"uid\":\"moexypnt3wd4\",\"public_id\":\"cal_moexypnt3wd4\",\"short_link\":null,\"name\":\"Test User's Calendar\",\"internal_name\":null,\"description\":\"

Professional meetings, webinars, and business events.<\\\/p>\",\"timezone\":\"Australia\\\/Sydney\",\"week_begins\":1,\"public_url\":\"https:\\\/\\\/addcal.co\\\/c\\\/moexypnt3wd4\",\"upcoming_events_count\":0,\"events_count\":0,\"created_at\":\"2025-07-29T23:34:05.000000Z\",\"updated_at\":\"2025-07-29T23:34:05.000000Z\"},{\"uid\":\"gvjtfhquosip\",\"public_id\":\"cal_gvjtfhquosip\",\"short_link\":null,\"name\":\"Test User's Calendar\",\"internal_name\":null,\"description\":\"

Personal events, family gatherings, and appointments.<\\\/p>\",\"timezone\":\"Australia\\\/Sydney\",\"week_begins\":1,\"public_url\":\"https:\\\/\\\/addcal.co\\\/c\\\/gvjtfhquosip\",\"upcoming_events_count\":0,\"events_count\":252,\"created_at\":\"2025-07-29T23:37:16.000000Z\",\"updated_at\":\"2025-07-29T23:37:16.000000Z\"},{\"uid\":\"yxlbclyhg4e7\",\"public_id\":\"cal_yxlbclyhg4e7\",\"short_link\":null,\"name\":\"Test User's Tags\",\"internal_name\":null,\"description\":\"

Professional meetings, webinars, and business events.<\\\/p>\",\"timezone\":\"Australia\\\/Sydney\",\"week_begins\":1,\"public_url\":\"https:\\\/\\\/addcal.co\\\/c\\\/yxlbclyhg4e7\",\"upcoming_events_count\":0,\"events_count\":13,\"created_at\":\"2025-07-29T23:43:37.000000Z\",\"updated_at\":\"2025-08-23T05:25:01.000000Z\"},{\"uid\":\"vj0wmxp7fo66\",\"public_id\":\"cal_vj0wmxp7fo66\",\"short_link\":\"test-cal\",\"name\":\"Recur test\",\"internal_name\":null,\"description\":\"\",\"timezone\":\"Australia\\\/Sydney\",\"week_begins\":1,\"public_url\":\"https:\\\/\\\/addcal.co\\\/c\\\/test-cal\",\"upcoming_events_count\":0,\"events_count\":40,\"created_at\":\"2025-09-07T00:12:49.000000Z\",\"updated_at\":\"2026-07-11T02:47:33.000000Z\"},{\"uid\":\"irir0ggat1pc\",\"public_id\":\"cal_irir0ggat1pc\",\"short_link\":null,\"name\":\"Series\",\"internal_name\":null,\"description\":\"\",\"timezone\":\"Australia\\\/Sydney\",\"week_begins\":1,\"public_url\":\"https:\\\/\\\/addcal.co\\\/c\\\/irir0ggat1pc\",\"upcoming_events_count\":0,\"events_count\":30,\"created_at\":\"2025-09-17T02:17:41.000000Z\",\"updated_at\":\"2025-09-17T02:17:41.000000Z\"},{\"uid\":\"vdp2pp652p6z\",\"public_id\":\"cal_vdp2pp652p6z\",\"short_link\":null,\"name\":\"Tag Filter Demo\",\"internal_name\":null,\"description\":\"

Seeded calendar for testing tag-filtered subscriptions.<\\\/p>\",\"timezone\":\"UTC\",\"week_begins\":1,\"public_url\":\"https:\\\/\\\/addcal.co\\\/c\\\/vdp2pp652p6z\",\"upcoming_events_count\":0,\"events_count\":9,\"created_at\":\"2026-07-29T01:28:22.000000Z\",\"updated_at\":\"2026-07-31T04:22:27.000000Z\"},{\"uid\":\"o5mn1flqqxo7\",\"public_id\":\"cal_o5mn1flqqxo7\",\"short_link\":null,\"name\":\"Tag Filter Demo (Require Info)\",\"internal_name\":null,\"description\":\"

Same tags, but gated behind the subscriber info form.<\\\/p>\",\"timezone\":\"UTC\",\"week_begins\":1,\"public_url\":\"https:\\\/\\\/addcal.co\\\/c\\\/o5mn1flqqxo7\",\"upcoming_events_count\":0,\"events_count\":3,\"created_at\":\"2026-07-29T01:28:22.000000Z\",\"updated_at\":\"2026-07-29T02:49:17.000000Z\"},{\"uid\":\"qr0d313df3vs\",\"public_id\":\"cal_qr0d313df3vs\",\"short_link\":null,\"name\":\"Tag Filter Demo (Opted Out)\",\"internal_name\":null,\"description\":\"

Tags exist but allow_tag_selection is off - control case.<\\\/p>\",\"timezone\":\"UTC\",\"week_begins\":1,\"public_url\":\"https:\\\/\\\/addcal.co\\\/c\\\/qr0d313df3vs\",\"upcoming_events_count\":0,\"events_count\":2,\"created_at\":\"2026-07-29T01:28:22.000000Z\",\"updated_at\":\"2026-07-29T01:28:22.000000Z\"},{\"uid\":\"4t0x0n0q6hvt\",\"public_id\":\"cal_4t0x0n0q6hvt\",\"short_link\":null,\"name\":\"vitae blanditiis rerum\",\"internal_name\":\"saepe eius ut\",\"description\":\"

Repudiandae quos suscipit similique saepe maiores. Omnis officiis qui placeat voluptates. Quia sunt corporis quis quasi harum in odio.<\\\/p>\",\"timezone\":\"UTC\",\"week_begins\":5,\"public_url\":\"https:\\\/\\\/addcal.co\\\/c\\\/4t0x0n0q6hvt\",\"upcoming_events_count\":0,\"events_count\":2,\"created_at\":\"2026-07-31T06:19:21.000000Z\",\"updated_at\":\"2026-07-31T06:19:21.000000Z\"},{\"uid\":\"hsr6p96ex40w\",\"public_id\":\"cal_hsr6p96ex40w\",\"short_link\":null,\"name\":\"rem quia maxime\",\"internal_name\":null,\"description\":\"

Cum optio dolor ducimus vitae enim. Consequatur perferendis velit non cum. Accusamus aut quidem dicta et numquam.<\\\/p>\",\"timezone\":\"UTC\",\"week_begins\":4,\"public_url\":\"https:\\\/\\\/addcal.co\\\/c\\\/hsr6p96ex40w\",\"upcoming_events_count\":2,\"events_count\":4,\"created_at\":\"2026-07-31T06:25:45.000000Z\",\"updated_at\":\"2026-07-31T06:25:45.000000Z\"},{\"uid\":\"w4beoawsjlzh\",\"public_id\":\"cal_w4beoawsjlzh\",\"short_link\":null,\"name\":\"magnam perspiciatis nesciunt\",\"internal_name\":null,\"description\":\"

Est quam commodi excepturi possimus. Expedita totam vel perferendis nesciunt est accusamus. Fugiat recusandae ipsam ducimus repudiandae. Possimus qui et tempore quasi architecto repellat.<\\\/p>\",\"timezone\":\"UTC\",\"week_begins\":4,\"public_url\":\"https:\\\/\\\/addcal.co\\\/c\\\/w4beoawsjlzh\",\"upcoming_events_count\":2,\"events_count\":4,\"created_at\":\"2026-07-31T06:25:45.000000Z\",\"updated_at\":\"2026-07-31T06:25:45.000000Z\"},{\"uid\":\"z9s82mzzyz9h\",\"public_id\":\"cal_z9s82mzzyz9h\",\"short_link\":null,\"name\":\"ut culpa doloribus\",\"internal_name\":null,\"description\":\"

Esse in voluptatem error delectus. Nesciunt delectus qui perferendis praesentium nihil tenetur. Eum sequi aut voluptatibus.<\\\/p>\",\"timezone\":\"UTC\",\"week_begins\":2,\"public_url\":\"https:\\\/\\\/addcal.co\\\/c\\\/z9s82mzzyz9h\",\"upcoming_events_count\":2,\"events_count\":4,\"created_at\":\"2026-07-31T06:25:45.000000Z\",\"updated_at\":\"2026-07-31T06:25:45.000000Z\"},{\"uid\":\"zn7jthtmcu6v\",\"public_id\":\"cal_zn7jthtmcu6v\",\"short_link\":null,\"name\":\"blanditiis qui similique\",\"internal_name\":null,\"description\":\"\",\"timezone\":\"UTC\",\"week_begins\":3,\"public_url\":\"https:\\\/\\\/addcal.co\\\/c\\\/zn7jthtmcu6v\",\"upcoming_events_count\":5,\"events_count\":12,\"created_at\":\"2026-07-31T06:25:45.000000Z\",\"updated_at\":\"2026-07-31T06:25:45.000000Z\"},{\"uid\":\"53shwnly2hec\",\"public_id\":\"cal_53shwnly2hec\",\"short_link\":null,\"name\":\"mollitia est sunt\",\"internal_name\":null,\"description\":\"\",\"timezone\":\"UTC\",\"week_begins\":6,\"public_url\":\"https:\\\/\\\/addcal.co\\\/c\\\/53shwnly2hec\",\"upcoming_events_count\":2,\"events_count\":4,\"created_at\":\"2026-07-31T06:30:17.000000Z\",\"updated_at\":\"2026-07-31T06:30:17.000000Z\"},{\"uid\":\"dtm5tai0heff\",\"public_id\":\"cal_dtm5tai0heff\",\"short_link\":null,\"name\":\"sit delectus aliquam\",\"internal_name\":\"ea sed esse\",\"description\":\"\",\"timezone\":\"UTC\",\"week_begins\":3,\"public_url\":\"https:\\\/\\\/addcal.co\\\/c\\\/dtm5tai0heff\",\"upcoming_events_count\":2,\"events_count\":4,\"created_at\":\"2026-07-31T06:30:17.000000Z\",\"updated_at\":\"2026-07-31T06:30:17.000000Z\"},{\"uid\":\"8lkpjn1v9478\",\"public_id\":\"cal_8lkpjn1v9478\",\"short_link\":null,\"name\":\"eveniet a nulla\",\"internal_name\":\"velit provident aperiam\",\"description\":\"\",\"timezone\":\"UTC\",\"week_begins\":2,\"public_url\":\"https:\\\/\\\/addcal.co\\\/c\\\/8lkpjn1v9478\",\"upcoming_events_count\":2,\"events_count\":24,\"created_at\":\"2026-07-31T06:30:17.000000Z\",\"updated_at\":\"2026-07-31T06:30:17.000000Z\"},{\"uid\":\"ffyq1eyfpzn4\",\"public_id\":\"cal_ffyq1eyfpzn4\",\"short_link\":null,\"name\":\"Wedding\",\"internal_name\":null,\"description\":\"\",\"timezone\":\"Australia\\\/Sydney\",\"week_begins\":1,\"public_url\":\"https:\\\/\\\/addcal.co\\\/c\\\/ffyq1eyfpzn4\",\"upcoming_events_count\":1,\"events_count\":1,\"created_at\":\"2026-08-13T02:53:56.000000Z\",\"updated_at\":\"2026-08-13T02:53:56.000000Z\"},{\"uid\":\"4vym88ak6pnj\",\"public_id\":\"cal_4vym88ak6pnj\",\"short_link\":null,\"name\":\"Default Calendar\",\"internal_name\":null,\"description\":\"\",\"timezone\":\"Australia\\\/Sydney\",\"week_begins\":1,\"public_url\":\"https:\\\/\\\/addcal.co\\\/c\\\/4vym88ak6pnj\",\"upcoming_events_count\":0,\"events_count\":4,\"created_at\":\"2026-08-16T09:50:40.000000Z\",\"updated_at\":\"2026-08-16T09:50:40.000000Z\"},{\"uid\":\"77r9qzpie5xw\",\"public_id\":\"cal_77r9qzpie5xw\",\"short_link\":null,\"name\":\"Imported Events\",\"internal_name\":null,\"description\":\"

Events imported from your public event creations.<\\\/p>\",\"timezone\":\"Australia\\\/Sydney\",\"week_begins\":1,\"public_url\":\"https:\\\/\\\/addcal.co\\\/c\\\/77r9qzpie5xw\",\"upcoming_events_count\":0,\"events_count\":1,\"created_at\":\"2026-08-16T21:35:16.000000Z\",\"updated_at\":\"2026-08-16T21:35:16.000000Z\"}]}", "name": "" } ] }, { "name": "Create Calendar", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars", "query": [], "raw": "{{baseUrl}}\/api\/calendars" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"zxplduayr\",\"internal_name\":\"rjzj\",\"description\":\"Non repellendus eligendi impedit aspernatur.\",\"timezone\":\"Africa\\\/Brazzaville\",\"week_begins\":5}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 409, "body": "{\"message\": \"You have reached your calendar limit. Please upgrade your plan to create more calendars.\"}", "name": "" } ] }, { "name": "Get Calendar", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars\/:public_id", "query": [], "raw": "{{baseUrl}}\/api\/calendars\/:public_id", "variable": [ { "id": "public_id", "key": "public_id", "value": "cal_p9v02qsz079d", "description": "The ID of the public." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 200, "body": "{\"data\":{\"uid\":\"p9v02qsz079d\",\"public_id\":\"cal_p9v02qsz079d\",\"short_link\":null,\"name\":\"Test RSVP Cal\",\"internal_name\":null,\"description\":\"\",\"timezone\":\"Australia\\\/Adelaide\",\"week_begins\":4,\"public_url\":\"https:\\\/\\\/addcal.co\\\/c\\\/p9v02qsz079d\",\"upcoming_events_count\":2,\"events_count\":72,\"created_at\":\"2025-07-27T06:43:09.000000Z\",\"updated_at\":\"2025-11-18T03:43:23.000000Z\"}}", "name": "" } ] }, { "name": "Update Calendar", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars\/:public_id", "query": [], "raw": "{{baseUrl}}\/api\/calendars\/:public_id", "variable": [ { "id": "public_id", "key": "public_id", "value": "cal_p9v02qsz079d", "description": "The ID of the public." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"zsbvmmarvcxzpzneeqrugpwps\",\"internal_name\":\"xbaazfazbqwyhgqymyux\",\"description\":\"Voluptatem voluptatem ipsa sequi atque inventore.\",\"timezone\":\"America\\\/Barbados\",\"week_begins\":5}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Delete Calendar", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars\/:public_id", "query": [], "raw": "{{baseUrl}}\/api\/calendars\/:public_id", "variable": [ { "id": "public_id", "key": "public_id", "value": "cal_p9v02qsz079d", "description": "The ID of the public." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Generate Signed URL", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars\/:calendar_public_id\/signed-url", "query": [], "raw": "{{baseUrl}}\/api\/calendars\/:calendar_public_id\/signed-url", "variable": [ { "id": "calendar_public_id", "key": "calendar_public_id", "value": "cal_p9v02qsz079d", "description": "The ID of the calendar public." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"expiry_days\":30}" }, "description": "Generate a signed URL for a protected calendar. The URL includes an expiry timestamp and a cryptographic signature, and expires after the specified number of days.\n\nThe calendar must have an access code set. If no `expiry_days` is provided, the calendar's configured `signed_url_expiry_days` is used, or 30 days as a default.\n\nThe returned URL grants temporary access based on its signature validity, without exposing the access code. It can be shared with users who need time-limited access.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"url\": \"https:\/\/addcal.co\/c\/cal_abc123?expires=1741000000&signature=abc...\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"error\": \"Calendar does not have an access code set.\"}", "name": "" } ] } ] }, { "name": "Calendars > Subscribers", "description": "APIs for reading the people who have subscribed to a calendar.\n\n## Matching subscribers to your own records\n\nPass `external_id` when someone subscribes and that value comes back here, so an AddCal\nsubscriber can be reconciled against a record in your own system.\n\nSet it on an embed as `data-external-id`, or on a link to a hosted calendar page as\n`?external_id=`:\n\n```\n

<\/div>\n\nhttps:\/\/addcal.co\/c\/cal_abc123?external_id=member-8412\n```\n\n**The subscribe route drops a malformed id silently.** It accepts 1-191 characters matching\n`^[A-Za-z0-9._:-]+$`; anything else is discarded and the subscribe still succeeds, with no\nerror and no field in the response. That is deliberate: the person subscribing is a real\nvisitor, and an id that only matters to your integration should not fail their subscribe.\n\nThe practical consequence is that an email address, a base64 token, or anything over 191\ncharacters will never reach this endpoint, and the first sign of it is a subscriber that\ncannot be matched. Validate the shape on your side before you send it. This endpoint does\nreject a malformed `external_id` with a 422, so it can be used to check an id's shape.\n\nTo find whether one of your records is subscribed, filter by it and check whether the\nresponse contains any rows:\n\n```\nGET \/api\/calendars\/cal_abc123\/subscribers?external_id=member-8412\n```", "item": [ { "name": "List subscribers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars\/:calendar_public_id\/subscribers", "query": [ { "key": "external_id", "value": "member-8412", "description": "Only return subscribers carrying this external id.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Number of results per page (1-100)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/calendars\/:calendar_public_id\/subscribers?external_id=member-8412&per_page=25", "variable": [ { "id": "calendar_public_id", "key": "calendar_public_id", "value": "cal_p9v02qsz079d", "description": "The ID of the calendar public." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"external_id\":\"sx\",\"per_page\":8}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"uid\":\"vuh5fsk8wh62wr\",\"public_id\":\"sub_vuh5fsk8wh62wr\",\"service\":\"outlook\",\"name\":null,\"email\":null,\"data\":null,\"status\":\"inactive\",\"created_at\":\"2026-08-28T03:20:12.000000Z\",\"updated_at\":\"2026-08-28T03:20:12.000000Z\"},{\"uid\":\"d2w829050qqm73\",\"public_id\":\"sub_d2w829050qqm73\",\"service\":\"ics\",\"name\":null,\"email\":null,\"data\":null,\"status\":\"inactive\",\"created_at\":\"2026-08-28T03:20:12.000000Z\",\"updated_at\":\"2026-08-28T03:20:12.000000Z\"}]}", "name": "" } ] } ] }, { "name": "Events", "description": "Advanced APIs for managing events", "item": [ { "name": "Index All Events", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/events", "query": [ { "key": "range", "value": "upcoming", "description": "Filter events by time range. Options: 'all', 'upcoming', 'past'", "disabled": false }, { "key": "search", "value": "team meeting", "description": "Search events by title or internal name", "disabled": false }, { "key": "calendar", "value": "cal_abc123", "description": "Filter events by calendar ID", "disabled": false }, { "key": "start_date", "value": "2024-01-01T00:00:00Z", "description": "Filter events starting from this date (ISO 8601 format)", "disabled": false }, { "key": "end_date", "value": "2024-12-31T23:59:59Z", "description": "Filter events ending before this date (ISO 8601 format)", "disabled": false }, { "key": "rsvp", "value": "1", "description": "Only return events with RSVPs enabled (true) or disabled (false)", "disabled": false }, { "key": "invites", "value": "1", "description": "Only return events with calendar invites enabled (true) or disabled (false)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/events?range=upcoming&search=team%20meeting&calendar=cal_abc123&start_date=2024-01-01T00%3A00%3A00Z&end_date=2024-12-31T23%3A59%3A59Z&rsvp=1&invites=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"range\":\"past\",\"search\":\"ffwng\",\"calendar\":\"yhez\",\"start_date\":\"2026-08-28T03:20:12\",\"end_date\":\"2026-08-28T03:20:12\",\"rsvp\":\"true\",\"invites\":\"true\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"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\":\"

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

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\":\"

Optio eius qui quod ut non. Et porro sapiente earum. Id hic reprehenderit amet nihil quasi.<\\\/p>\\n\\n

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\"}]}", "name": "" } ] }, { "name": "Get Event by UID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/events\/:event_public_id", "query": [ { "key": "with_html", "value": "1", "description": "Include HTML variants for calendar links in the response", "disabled": false } ], "raw": "{{baseUrl}}\/api\/events\/:event_public_id?with_html=1", "variable": [ { "id": "event_public_id", "key": "event_public_id", "value": "evt_2ksqz788l9h3", "description": "The ID of the event public." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"uid\":\"w7kge7r8h8q5\",\"public_id\":\"evt_w7kge7r8h8q5\",\"calendar_uid\":\"cal_z1apbwfu7ttp\",\"short_link\":null,\"title\":\"Et similique rem non.\",\"internal_name\":null,\"is_draft\":false,\"description\":\"

Natus aut ex aut laborum quas veniam illum. Itaque eaque nulla rem et doloremque occaecati quas consectetur. Cupiditate dolor vero magnam modi numquam enim explicabo harum.<\\\/p>\\n\\n

Blanditiis numquam iste consectetur labore iste. Optio laboriosam alias alias voluptatem ut. Debitis enim a neque quo. Est sunt laborum nihil dicta voluptatem rerum adipisci.<\\\/p>\",\"location\":\"6785 Considine Plaza\\nHaleyland, CO 55689-9043\",\"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-08-21T14:11:30-05:00\",\"date_end\":\"2026-08-21T16:11:30-05:00\",\"timezone\":\"America\\\/Eirunepe\",\"busy_type\":null,\"reminder_before\":null,\"date_range_formatted\":\"Fri, Aug 21, 2026 2:11 PM - 4:11 PM\",\"public_url\":\"http:\\\/\\\/addcal.co\\\/e\\\/w7kge7r8h8q5\",\"embed_url\":\"http:\\\/\\\/addcal.co\\\/e\\\/w7kge7r8h8q5\",\"location_url\":null,\"image_url\":null,\"timezone_readable\":\"-05 \\\/ GMT-05:00\",\"calendar\":{\"uid\":\"z1apbwfu7ttp\",\"public_id\":\"cal_z1apbwfu7ttp\",\"short_link\":null,\"name\":\"totam nobis voluptates\",\"internal_name\":\"explicabo est laboriosam\",\"description\":\"\",\"timezone\":\"Europe\\\/Moscow\",\"week_begins\":1,\"public_url\":\"http:\\\/\\\/addcal.co\\\/c\\\/z1apbwfu7ttp\",\"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\"},\"links\":{\"event_page\":\"http:\\\/\\\/addcal.co\\\/e\\\/w7kge7r8h8q5\",\"auto\":\"https:\\\/\\\/addcal.co\\\/e\\\/w7kge7r8h8q5\\\/auto\",\"google\":\"https:\\\/\\\/addcal.co\\\/e\\\/w7kge7r8h8q5\\\/google\",\"apple\":\"https:\\\/\\\/addcal.co\\\/e\\\/w7kge7r8h8q5\\\/apple\",\"outlook\":\"https:\\\/\\\/addcal.co\\\/e\\\/w7kge7r8h8q5\\\/outlook\",\"outlook_web\":\"https:\\\/\\\/addcal.co\\\/e\\\/w7kge7r8h8q5\\\/outlook_web\",\"yahoo\":\"https:\\\/\\\/addcal.co\\\/e\\\/w7kge7r8h8q5\\\/yahoo\",\"office365\":\"https:\\\/\\\/addcal.co\\\/e\\\/w7kge7r8h8q5\\\/office365\",\"ics\":\"https:\\\/\\\/addcal.co\\\/e\\\/w7kge7r8h8q5\\\/ics\"},\"html\":{\"single-button\":\"Add to Calendar Button\",\"icon-buttons-single-row\":\"Buttons With Icons\",\"icons\":\"Text with Icons\",\"dot-sep\":\"Text (dot separated)\",\"space-sep\":\"Text (space separated)\"}}", "name": "" } ] }, { "name": "Index Calendar Events", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars\/:calendar_public_id\/events", "query": [ { "key": "range", "value": "upcoming", "description": "Filter events by time range. Options: 'all', 'upcoming', 'past'", "disabled": false }, { "key": "search", "value": "team meeting", "description": "Search events by title or internal name", "disabled": false }, { "key": "calendar", "value": "cal_abc123", "description": "Filter events by calendar ID", "disabled": false }, { "key": "start_date", "value": "2024-01-01T00:00:00Z", "description": "Filter events starting from this date (ISO 8601 format)", "disabled": false }, { "key": "end_date", "value": "2024-12-31T23:59:59Z", "description": "Filter events ending before this date (ISO 8601 format)", "disabled": false }, { "key": "rsvp", "value": "1", "description": "Only return events with RSVPs enabled (true) or disabled (false)", "disabled": false }, { "key": "invites", "value": "1", "description": "Only return events with calendar invites enabled (true) or disabled (false)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/calendars\/:calendar_public_id\/events?range=upcoming&search=team%20meeting&calendar=cal_abc123&start_date=2024-01-01T00%3A00%3A00Z&end_date=2024-12-31T23%3A59%3A59Z&rsvp=1&invites=1", "variable": [ { "id": "calendar_public_id", "key": "calendar_public_id", "value": "cal_p9v02qsz079d", "description": "The ID of the calendar public." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"range\":\"upcoming\",\"search\":\"hevehqnloksobnelxetrskonw\",\"calendar\":\"hlmtgftyqoqvzfhzmaukt\",\"start_date\":\"2026-08-28T03:20:12\",\"end_date\":\"2026-08-28T03:20:12\",\"rsvp\":\"true\",\"invites\":\"true\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"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\":\"

Quae qui qui blanditiis quisquam aut eum. Et ullam at a. Omnis soluta dolorem optio alias qui.<\\\/p>\\n\\n

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\":\"

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

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\":\"

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\"}]}", "name": "" } ] }, { "name": "Create Event", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars\/:calendar_public_id\/events", "query": [ { "key": "with_html", "value": "1", "description": "Include HTML variants for calendar links in the response", "disabled": false } ], "raw": "{{baseUrl}}\/api\/calendars\/:calendar_public_id\/events?with_html=1", "variable": [ { "id": "calendar_public_id", "key": "calendar_public_id", "value": "cal_p9v02qsz079d", "description": "The ID of the calendar public." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"qfklgofxpwqrzoyyso\",\"internal_name\":\"qnejarzznkmdbpdzsvgawqge\",\"is_draft\":true,\"description\":\"Sed quia assumenda hic sed.\",\"location\":\"yhvzbvbwzdunsfdynvfngckud\",\"is_all_day\":false,\"series_title\":\"gymxabwgycqcqerkqam\",\"has_rsvp\":true,\"date_start\":\"2026-08-28T03:20:12\",\"date_end\":\"2038-06-19\",\"timezone\":\"Asia\\\/Kuala_Lumpur\",\"busy_type\":\"free\",\"reminder_before\":38,\"short_link\":\"bdqcwkcthudpkbrdnnzhbhspl\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"uid\":\"7v4ykqe3kiwl\",\"public_id\":\"evt_7v4ykqe3kiwl\",\"calendar_uid\":\"cal_fo3p4eu2bv2c\",\"short_link\":null,\"title\":\"Et rerum sint sit tempora sapiente veritatis.\",\"internal_name\":null,\"is_draft\":false,\"description\":\"

Eum officia harum quaerat voluptate laborum omnis deleniti. Culpa qui et nobis quae non ut. Pariatur esse deleniti doloribus non eos beatae dolor laudantium.<\\\/p>\\n\\n

Corrupti et fuga nihil. Vel itaque et et. Quia dolorem repudiandae saepe eveniet. Et enim et voluptatum quis expedita aspernatur adipisci.<\\\/p>\",\"location\":null,\"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-07-31T11:48:47+08:00\",\"date_end\":\"2026-07-31T12:48:47+08:00\",\"timezone\":\"Asia\\\/Shanghai\",\"busy_type\":null,\"reminder_before\":null,\"date_range_formatted\":\"Fri, Jul 31, 2026 11:48 AM - 12:48 PM\",\"public_url\":\"http:\\\/\\\/addcal.co\\\/e\\\/7v4ykqe3kiwl\",\"embed_url\":\"http:\\\/\\\/addcal.co\\\/e\\\/7v4ykqe3kiwl\",\"location_url\":null,\"image_url\":null,\"timezone_readable\":\"CST \\\/ GMT+08:00\",\"calendar\":{\"uid\":\"fo3p4eu2bv2c\",\"public_id\":\"cal_fo3p4eu2bv2c\",\"short_link\":null,\"name\":\"et dolor commodi\",\"internal_name\":null,\"description\":\"

Quos corporis minima non impedit et. Architecto et velit natus. Sed id necessitatibus omnis atque ipsa rerum. Unde quo labore eos sed.<\\\/p>\",\"timezone\":\"America\\\/St_Lucia\",\"week_begins\":1,\"public_url\":\"http:\\\/\\\/addcal.co\\\/c\\\/fo3p4eu2bv2c\",\"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\"},\"links\":{\"event_page\":\"http:\\\/\\\/addcal.co\\\/e\\\/7v4ykqe3kiwl\",\"auto\":\"https:\\\/\\\/addcal.co\\\/e\\\/7v4ykqe3kiwl\\\/auto\",\"google\":\"https:\\\/\\\/addcal.co\\\/e\\\/7v4ykqe3kiwl\\\/google\",\"apple\":\"https:\\\/\\\/addcal.co\\\/e\\\/7v4ykqe3kiwl\\\/apple\",\"outlook\":\"https:\\\/\\\/addcal.co\\\/e\\\/7v4ykqe3kiwl\\\/outlook\",\"outlook_web\":\"https:\\\/\\\/addcal.co\\\/e\\\/7v4ykqe3kiwl\\\/outlook_web\",\"yahoo\":\"https:\\\/\\\/addcal.co\\\/e\\\/7v4ykqe3kiwl\\\/yahoo\",\"office365\":\"https:\\\/\\\/addcal.co\\\/e\\\/7v4ykqe3kiwl\\\/office365\",\"ics\":\"https:\\\/\\\/addcal.co\\\/e\\\/7v4ykqe3kiwl\\\/ics\"},\"html\":{\"single-button\":\"Add to Calendar Button\",\"icon-buttons-single-row\":\"Buttons With Icons\",\"icons\":\"Text with Icons\",\"dot-sep\":\"Text (dot separated)\",\"space-sep\":\"Text (space separated)\"}}", "name": "" }, { "header": [], "code": 409, "body": "{\"message\":\"You have reached your monthly event limit of 10. Please upgrade your plan to create more events.\",\"current\":10,\"limit\":10,\"remaining\":0,\"would_exceed_by\":1,\"is_unlimited\":false,\"limit_type\":\"monthly\"}", "name": "When the team's event limit has been exceeded" } ] }, { "name": "Get Event", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars\/:calendar_public_id\/events\/:public_id", "query": [ { "key": "with_html", "value": "1", "description": "Include HTML variants for calendar links in the response", "disabled": false } ], "raw": "{{baseUrl}}\/api\/calendars\/:calendar_public_id\/events\/:public_id?with_html=1", "variable": [ { "id": "calendar_public_id", "key": "calendar_public_id", "value": "cal_p9v02qsz079d", "description": "The ID of the calendar public." }, { "id": "public_id", "key": "public_id", "value": "evt_2ksqz788l9h3", "description": "The ID of the public." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"uid\":\"yead8xfb2wf7\",\"public_id\":\"evt_yead8xfb2wf7\",\"calendar_uid\":\"cal_jox7j7hp6lhs\",\"short_link\":null,\"title\":\"Sunt quis error et maxime ea.\",\"internal_name\":null,\"is_draft\":false,\"description\":\"

Sint natus nam repudiandae recusandae aut a sit. Quis eos vero amet veniam iusto. Sunt ut reprehenderit rerum commodi. Voluptatem voluptatem voluptatibus laboriosam voluptates.<\\\/p>\\n\\n

Et eos ut consequatur deleniti voluptates rem nam. Assumenda tempora est sunt et est facere. Et illum unde et natus.<\\\/p>\",\"location\":\"405 Graham Drives\\nLake Chelsea, AR 03463\",\"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-04T22:45:56-05:00\",\"date_end\":\"2026-09-05T00:45:56-05:00\",\"timezone\":\"America\\\/North_Dakota\\\/Beulah\",\"busy_type\":null,\"reminder_before\":null,\"date_range_formatted\":\"Fri, Sep 4, 2026 10:45 PM - Sat, Sep 5, 2026 12:45 AM\",\"public_url\":\"http:\\\/\\\/addcal.co\\\/e\\\/yead8xfb2wf7\",\"embed_url\":\"http:\\\/\\\/addcal.co\\\/e\\\/yead8xfb2wf7\",\"location_url\":null,\"image_url\":null,\"timezone_readable\":\"CDT \\\/ GMT-05:00\",\"calendar\":{\"uid\":\"jox7j7hp6lhs\",\"public_id\":\"cal_jox7j7hp6lhs\",\"short_link\":null,\"name\":\"blanditiis a aspernatur\",\"internal_name\":null,\"description\":\"\",\"timezone\":\"Africa\\\/Bamako\",\"week_begins\":0,\"public_url\":\"http:\\\/\\\/addcal.co\\\/c\\\/jox7j7hp6lhs\",\"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\"},\"links\":{\"event_page\":\"http:\\\/\\\/addcal.co\\\/e\\\/yead8xfb2wf7\",\"auto\":\"https:\\\/\\\/addcal.co\\\/e\\\/yead8xfb2wf7\\\/auto\",\"google\":\"https:\\\/\\\/addcal.co\\\/e\\\/yead8xfb2wf7\\\/google\",\"apple\":\"https:\\\/\\\/addcal.co\\\/e\\\/yead8xfb2wf7\\\/apple\",\"outlook\":\"https:\\\/\\\/addcal.co\\\/e\\\/yead8xfb2wf7\\\/outlook\",\"outlook_web\":\"https:\\\/\\\/addcal.co\\\/e\\\/yead8xfb2wf7\\\/outlook_web\",\"yahoo\":\"https:\\\/\\\/addcal.co\\\/e\\\/yead8xfb2wf7\\\/yahoo\",\"office365\":\"https:\\\/\\\/addcal.co\\\/e\\\/yead8xfb2wf7\\\/office365\",\"ics\":\"https:\\\/\\\/addcal.co\\\/e\\\/yead8xfb2wf7\\\/ics\"},\"html\":{\"single-button\":\"Add to Calendar Button\",\"icon-buttons-single-row\":\"Buttons With Icons\",\"icons\":\"Text with Icons\",\"dot-sep\":\"Text (dot separated)\",\"space-sep\":\"Text (space separated)\"}}", "name": "" } ] }, { "name": "Update Event", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars\/:calendar_public_id\/events\/:public_id", "query": [ { "key": "with_html", "value": "1", "description": "Include HTML variants for calendar links in the response", "disabled": false } ], "raw": "{{baseUrl}}\/api\/calendars\/:calendar_public_id\/events\/:public_id?with_html=1", "variable": [ { "id": "calendar_public_id", "key": "calendar_public_id", "value": "cal_p9v02qsz079d", "description": "The ID of the calendar public." }, { "id": "public_id", "key": "public_id", "value": "evt_2ksqz788l9h3", "description": "The ID of the public." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"wzutpboymqcdhnci\",\"internal_name\":\"d\",\"is_draft\":true,\"description\":\"Error ut sit omnis amet voluptatem dolore ducimus ratione.\",\"location\":\"f\",\"is_all_day\":true,\"series_title\":\"poqrszloaveloubrikvh\",\"has_rsvp\":false,\"send_invite_updates\":false,\"date_start\":\"2026-08-28T03:20:12\",\"date_end\":\"2039-03-23\",\"timezone\":\"Asia\\\/Bangkok\",\"busy_type\":\"busy\",\"reminder_before\":79,\"short_link\":\"wmtcyxfbohadhiu\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"uid\":\"zxtmtrgpl1kv\",\"public_id\":\"evt_zxtmtrgpl1kv\",\"calendar_uid\":\"cal_hf1t8frn77k5\",\"short_link\":null,\"title\":\"Recusandae fuga similique natus earum.\",\"internal_name\":null,\"is_draft\":false,\"description\":\"

Non qui veniam eum omnis. Distinctio facilis et molestiae exercitationem minus eligendi tempore. Voluptas minus doloribus saepe provident facilis.<\\\/p>\\n\\n

Ad dolor ut et ullam reprehenderit et. Non eum iusto qui ipsa dolorem est. Cum et qui eligendi officia dolores.<\\\/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-02T02:42:09+00:00\",\"date_end\":\"2026-09-02T06:42:09+00:00\",\"timezone\":null,\"busy_type\":null,\"reminder_before\":null,\"date_range_formatted\":\"Wed, Sep 2, 2026 (all day)\",\"public_url\":\"http:\\\/\\\/addcal.co\\\/e\\\/zxtmtrgpl1kv\",\"embed_url\":\"http:\\\/\\\/addcal.co\\\/e\\\/zxtmtrgpl1kv\",\"location_url\":null,\"image_url\":null,\"timezone_readable\":null,\"calendar\":{\"uid\":\"hf1t8frn77k5\",\"public_id\":\"cal_hf1t8frn77k5\",\"short_link\":null,\"name\":\"voluptatem sed neque\",\"internal_name\":\"molestias animi distinctio\",\"description\":\"

Non unde consectetur est velit. Recusandae tempore et tempora similique. Voluptate et totam voluptas voluptates.<\\\/p>\",\"timezone\":\"Africa\\\/Libreville\",\"week_begins\":6,\"public_url\":\"http:\\\/\\\/addcal.co\\\/c\\\/hf1t8frn77k5\",\"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\"},\"links\":{\"event_page\":\"http:\\\/\\\/addcal.co\\\/e\\\/zxtmtrgpl1kv\",\"auto\":\"https:\\\/\\\/addcal.co\\\/e\\\/zxtmtrgpl1kv\\\/auto\",\"google\":\"https:\\\/\\\/addcal.co\\\/e\\\/zxtmtrgpl1kv\\\/google\",\"apple\":\"https:\\\/\\\/addcal.co\\\/e\\\/zxtmtrgpl1kv\\\/apple\",\"outlook\":\"https:\\\/\\\/addcal.co\\\/e\\\/zxtmtrgpl1kv\\\/outlook\",\"outlook_web\":\"https:\\\/\\\/addcal.co\\\/e\\\/zxtmtrgpl1kv\\\/outlook_web\",\"yahoo\":\"https:\\\/\\\/addcal.co\\\/e\\\/zxtmtrgpl1kv\\\/yahoo\",\"office365\":\"https:\\\/\\\/addcal.co\\\/e\\\/zxtmtrgpl1kv\\\/office365\",\"ics\":\"https:\\\/\\\/addcal.co\\\/e\\\/zxtmtrgpl1kv\\\/ics\"},\"html\":{\"single-button\":\"Add to Calendar Button\",\"icon-buttons-single-row\":\"Buttons With Icons\",\"icons\":\"Text with Icons\",\"dot-sep\":\"Text (dot separated)\",\"space-sep\":\"Text (space separated)\"}}", "name": "" } ] }, { "name": "Delete Event", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars\/:calendar_public_id\/events\/:public_id", "query": [], "raw": "{{baseUrl}}\/api\/calendars\/:calendar_public_id\/events\/:public_id", "variable": [ { "id": "calendar_public_id", "key": "calendar_public_id", "value": "cal_p9v02qsz079d", "description": "The ID of the calendar public." }, { "id": "public_id", "key": "public_id", "value": "evt_2ksqz788l9h3", "description": "The ID of the public." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"notify_invitees\":true}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Generate Signed URL for Event", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars\/:calendar_public_id\/events\/:event_public_id\/signed-url", "query": [], "raw": "{{baseUrl}}\/api\/calendars\/:calendar_public_id\/events\/:event_public_id\/signed-url", "variable": [ { "id": "calendar_public_id", "key": "calendar_public_id", "value": "cal_p9v02qsz079d", "description": "The ID of the calendar public." }, { "id": "event_public_id", "key": "event_public_id", "value": "evt_2ksqz788l9h3", "description": "The ID of the event public." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"expiry_days\":30}" }, "description": "Generate a cryptographically signed URL for a protected event. The signed URL grants temporary access and expires after the specified number of days.\n\nThe event must have an access code set. If no `expiry_days` is provided, the default is 30 days.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"url\": \"https:\/\/addcal.co\/e\/evt_abc123?expires=1741000000&signature=abc...\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"error\": \"Event does not have an access code set.\"}", "name": "" } ] } ] }, { "name": "Events > RSVPs", "description": "APIs for managing event RSVP responses.\n\n## Working with Custom Form Fields\n\nEvents can have custom forms with additional fields beyond the standard `name` and `email`. To create an RSVP with custom field data:\n\n1. First, fetch the event details using the **Get Event** endpoint (`GET \/api\/calendars\/{calendar}\/events\/{event}`)\n2. Check the `custom_form` object in the response - it contains a `fields` array with all form fields\n3. Use each field's `slug` property as the key when submitting custom field data\n\n### Example Workflow\n\n```\nGET \/api\/calendars\/cal_abc123\/events\/evt_xyz789\n\nResponse:\n{\n \"data\": {\n \"custom_form\": {\n \"fields\": [\n { \"slug\": \"company\", \"label\": \"Company Name\", \"field_type\": \"text\", \"is_required\": false },\n { \"slug\": \"dietary_requirements\", \"label\": \"Dietary Requirements\", \"field_type\": \"dropdown\", \"is_required\": true,\n \"options\": [{ \"label\": \"Vegetarian\", \"value\": \"vegetarian\" }, { \"label\": \"None\", \"value\": \"none\" }] }\n ]\n }\n }\n}\n```\n\nThen create the RSVP, passing the custom field values in `custom_fields`, keyed by slug:\n\n```\nPOST \/api\/calendars\/cal_abc123\/events\/evt_xyz789\/rsvps\n\n{\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"response_type\": \"yes\",\n \"custom_fields\": {\n \"company\": \"Acme Inc\",\n \"dietary_requirements\": \"vegetarian\"\n }\n}\n```\n\nFor fields of type `name_field` and `email_field`, send the value as the top-level `name` \/ `email`\ninstead of inside `custom_fields`.\n\n### Strict validation (opt-in)\n\nBy default the API is lenient: `custom_fields` are stored as sent, without enforcing the form's\nrequired fields, option lists, or field types. This keeps existing integrations working.\n\nPass `\"strict\": true` to validate the submission exactly like the public RSVP form: fields marked\n`is_required` must be present, `dropdown`\/`radio` values must be one of the field's `options[].value`,\nand typed fields (e.g. `marketing_consent`) must match their type. Note `marketing_consent` values\nmust be a JSON boolean (`true`\/`false`), not a string like `\"True\"`.\n\nEarlier versions of this API accepted these values as a flat `data` object. That shape is still\naccepted, but it is deprecated: prefer `custom_fields`.", "item": [ { "name": "List RSVPs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars\/:calendar_public_id\/events\/:event_public_id\/rsvps", "query": [ { "key": "response_type", "value": "yes", "description": "Filter by response type. Options: 'yes', 'maybe', 'no'", "disabled": false }, { "key": "search", "value": "john@example.com", "description": "Search RSVPs by name or email", "disabled": false }, { "key": "per_page", "value": "25", "description": "Number of results per page (1-100)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/calendars\/:calendar_public_id\/events\/:event_public_id\/rsvps?response_type=yes&search=john%40example.com&per_page=25", "variable": [ { "id": "calendar_public_id", "key": "calendar_public_id", "value": "cal_p9v02qsz079d", "description": "The ID of the calendar public." }, { "id": "event_public_id", "key": "event_public_id", "value": "evt_2ksqz788l9h3", "description": "The ID of the event public." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"response_type\":\"voluptas\",\"search\":\"nnvruomre\",\"per_page\":16}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"uid\":\"28e5b3fb-de64-470d-9189-b76e187dd3d1\",\"public_id\":\"rsvp_28e5b3fb-de64-470d-9189-b76e187dd3d1\",\"event_uid\":\"yp9y906q64sy\",\"response_type\":\"maybe\",\"name\":\"Robbie Bruen PhD\",\"email\":\"agerlach@hotmail.com\",\"data\":{\"guests\":2,\"comment\":\"Suscipit consequatur laudantium tempora nisi aut nihil aspernatur.\"},\"formatted_created_at\":\"2026-08-28 03:20:12\",\"created_at\":\"2026-08-28T03:20:12.000000Z\",\"updated_at\":\"2026-08-28T03:20:12.000000Z\",\"event\":{\"uid\":\"yp9y906q64sy\",\"public_id\":\"evt_yp9y906q64sy\",\"calendar_uid\":\"cal_4mwxgiecjmax\",\"short_link\":null,\"title\":\"Rerum consectetur et rerum.\",\"internal_name\":null,\"is_draft\":false,\"description\":\"

Numquam ipsum sed dolorem velit consequatur velit. Officiis error odit iusto totam laboriosam sed. Quis repellendus amet deserunt et est voluptas suscipit. Molestiae molestiae animi quo quia consectetur explicabo nihil eum.<\\\/p>\\n\\n

Alias voluptatem facere ad commodi suscipit. Animi qui asperiores quod velit. Beatae asperiores culpa enim aut magni sint et.<\\\/p>\",\"location\":\"403 Felipe Ports\\nSouth Meggiefurt, SC 13640\",\"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-04T07:06:18+02:00\",\"date_end\":\"2026-09-04T11:06:18+02:00\",\"timezone\":\"Europe\\\/Prague\",\"busy_type\":null,\"reminder_before\":null,\"date_range_formatted\":\"Fri, Sep 4, 2026 7:06 AM - 11:06 AM\",\"public_url\":\"http:\\\/\\\/addcal.co\\\/e\\\/yp9y906q64sy\",\"embed_url\":\"http:\\\/\\\/addcal.co\\\/e\\\/yp9y906q64sy\",\"location_url\":null,\"image_url\":null,\"timezone_readable\":\"CEST \\\/ GMT+02:00\",\"calendar\":{\"uid\":\"4mwxgiecjmax\",\"public_id\":\"cal_4mwxgiecjmax\",\"short_link\":null,\"name\":\"ut omnis numquam\",\"internal_name\":\"vero autem vitae\",\"description\":\"

Velit minima aliquid sed explicabo quibusdam ullam a. Facere unde sint doloribus quo rerum. Est repellat in ipsum dolores qui ut.<\\\/p>\",\"timezone\":\"Europe\\\/Gibraltar\",\"week_begins\":0,\"public_url\":\"http:\\\/\\\/addcal.co\\\/c\\\/4mwxgiecjmax\",\"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\":\"06f631c9-f451-4037-aebf-31576424356d\",\"public_id\":\"rsvp_06f631c9-f451-4037-aebf-31576424356d\",\"event_uid\":\"pakfrdhp5pdm\",\"response_type\":\"yes\",\"name\":\"Estel Bayer Sr.\",\"email\":\"stroman.lenna@crona.com\",\"data\":{\"guests\":3,\"comment\":\"Non eos quaerat cupiditate eos ratione ratione odio.\"},\"formatted_created_at\":\"2026-08-28 03:20:12\",\"created_at\":\"2026-08-28T03:20:12.000000Z\",\"updated_at\":\"2026-08-28T03:20:12.000000Z\",\"event\":{\"uid\":\"pakfrdhp5pdm\",\"public_id\":\"evt_pakfrdhp5pdm\",\"calendar_uid\":\"cal_10u6oafwx5pr\",\"short_link\":null,\"title\":\"Odio repellendus ut qui perferendis nobis dolorem.\",\"internal_name\":null,\"is_draft\":false,\"description\":\"

Quisquam soluta autem delectus quo quia porro. Fuga totam aut dolor nesciunt deserunt eius velit. Sapiente facilis est omnis ullam. Quidem incidunt amet quia cupiditate itaque nihil.<\\\/p>\\n\\n

Quos libero cum ea sed et. Dignissimos repudiandae placeat assumenda ut quae pariatur. Aspernatur officiis vitae voluptatibus harum rerum dolore velit. Laboriosam maiores omnis at neque praesentium et.<\\\/p>\",\"location\":null,\"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-13T22:34:44-04:00\",\"date_end\":\"2026-09-13T23:34:44-04:00\",\"timezone\":\"America\\\/Blanc-Sablon\",\"busy_type\":null,\"reminder_before\":null,\"date_range_formatted\":\"Sun, Sep 13, 2026 10:34 PM - 11:34 PM\",\"public_url\":\"http:\\\/\\\/addcal.co\\\/e\\\/pakfrdhp5pdm\",\"embed_url\":\"http:\\\/\\\/addcal.co\\\/e\\\/pakfrdhp5pdm\",\"location_url\":null,\"image_url\":null,\"timezone_readable\":\"AST \\\/ GMT-04:00\",\"calendar\":{\"uid\":\"10u6oafwx5pr\",\"public_id\":\"cal_10u6oafwx5pr\",\"short_link\":null,\"name\":\"cum possimus enim\",\"internal_name\":\"vel architecto rerum\",\"description\":\"\",\"timezone\":\"Atlantic\\\/Azores\",\"week_begins\":4,\"public_url\":\"http:\\\/\\\/addcal.co\\\/c\\\/10u6oafwx5pr\",\"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\"}}]}", "name": "" } ] }, { "name": "Create RSVP", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars\/:calendar_public_id\/events\/:event_public_id\/rsvps", "query": [], "raw": "{{baseUrl}}\/api\/calendars\/:calendar_public_id\/events\/:event_public_id\/rsvps", "variable": [ { "id": "calendar_public_id", "key": "calendar_public_id", "value": "cal_p9v02qsz079d", "description": "The ID of the calendar public." }, { "id": "event_public_id", "key": "event_public_id", "value": "evt_2ksqz788l9h3", "description": "The ID of the event public." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"response_type\":\"magni\",\"name\":\"frvxe\",\"email\":\"augusta.halvorson@example.com\",\"strict\":true}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"uid\":\"9259d39e-11e5-45fc-a5e9-65474e89a6a4\",\"public_id\":\"rsvp_9259d39e-11e5-45fc-a5e9-65474e89a6a4\",\"event_uid\":\"x7hi8wxomm2h\",\"response_type\":\"maybe\",\"name\":\"Ms. Beryl Kunze II\",\"email\":\"carter86@trantow.com\",\"data\":{\"guests\":0,\"comment\":\"Eos eos porro ipsa ducimus.\"},\"formatted_created_at\":\"2026-08-28 03:20:12\",\"created_at\":\"2026-08-28T03:20:12.000000Z\",\"updated_at\":\"2026-08-28T03:20:12.000000Z\",\"event\":{\"uid\":\"x7hi8wxomm2h\",\"public_id\":\"evt_x7hi8wxomm2h\",\"calendar_uid\":\"cal_lmjv9haksz2i\",\"short_link\":null,\"title\":\"Doloribus doloribus ut voluptatem est similique.\",\"internal_name\":null,\"is_draft\":false,\"description\":\"

Nihil odit qui totam cupiditate et. Provident architecto voluptatum autem et voluptatibus totam. Eligendi quasi et aliquid. Sequi officiis excepturi voluptas labore blanditiis autem quos.<\\\/p>\\n\\n

Et assumenda asperiores quidem in distinctio odit. Nostrum sequi illo non. Ad itaque ut ipsum dolorem eos et.<\\\/p>\",\"location\":\"25886 Tyrel Manors\\nTrompfort, NE 02773\",\"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-08-08T14:51:16+04:00\",\"date_end\":\"2026-08-08T18:51:16+04:00\",\"timezone\":\"Asia\\\/Muscat\",\"busy_type\":null,\"reminder_before\":null,\"date_range_formatted\":\"Sat, Aug 8, 2026 2:51 PM - 6:51 PM\",\"public_url\":\"http:\\\/\\\/addcal.co\\\/e\\\/x7hi8wxomm2h\",\"embed_url\":\"http:\\\/\\\/addcal.co\\\/e\\\/x7hi8wxomm2h\",\"location_url\":null,\"image_url\":null,\"timezone_readable\":\"+04 \\\/ GMT+04:00\",\"calendar\":{\"uid\":\"lmjv9haksz2i\",\"public_id\":\"cal_lmjv9haksz2i\",\"short_link\":null,\"name\":\"vitae nisi sint\",\"internal_name\":\"qui praesentium nesciunt\",\"description\":\"\",\"timezone\":\"Europe\\\/Athens\",\"week_begins\":6,\"public_url\":\"http:\\\/\\\/addcal.co\\\/c\\\/lmjv9haksz2i\",\"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\"}}", "name": "" } ] }, { "name": "Get RSVP", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars\/:calendar_public_id\/events\/:event_public_id\/rsvps\/:public_id", "query": [], "raw": "{{baseUrl}}\/api\/calendars\/:calendar_public_id\/events\/:event_public_id\/rsvps\/:public_id", "variable": [ { "id": "calendar_public_id", "key": "calendar_public_id", "value": "cal_p9v02qsz079d", "description": "The ID of the calendar public." }, { "id": "event_public_id", "key": "event_public_id", "value": "evt_2ksqz788l9h3", "description": "The ID of the event public." }, { "id": "public_id", "key": "public_id", "value": "rsvp_a1vwg8qt8o9n", "description": "The ID of the public." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"uid\":\"b47e0c53-2eb2-40a3-8957-21bf567df8ee\",\"public_id\":\"rsvp_b47e0c53-2eb2-40a3-8957-21bf567df8ee\",\"event_uid\":\"p3mwubr0q8wt\",\"response_type\":\"yes\",\"name\":\"Fleta Wintheiser\",\"email\":\"emmet.zieme@braun.com\",\"data\":{\"guests\":0,\"comment\":\"Dicta eveniet repellendus doloribus.\"},\"formatted_created_at\":\"2026-08-28 03:20:12\",\"created_at\":\"2026-08-28T03:20:12.000000Z\",\"updated_at\":\"2026-08-28T03:20:12.000000Z\",\"event\":{\"uid\":\"p3mwubr0q8wt\",\"public_id\":\"evt_p3mwubr0q8wt\",\"calendar_uid\":\"cal_fazboupkz9yi\",\"short_link\":null,\"title\":\"Sed eos aspernatur dignissimos veritatis.\",\"internal_name\":null,\"is_draft\":false,\"description\":\"

Incidunt necessitatibus quia quae nihil et. Dicta adipisci consectetur consequatur dolores ex quo. Vero suscipit perferendis id quia odit culpa.<\\\/p>\\n\\n

Libero ea officiis vitae eum autem deserunt sint. Hic cumque at earum sunt. Est recusandae ea non non incidunt.<\\\/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-23T12:00:28+00:00\",\"date_end\":\"2026-09-23T15:00:28+00:00\",\"timezone\":null,\"busy_type\":null,\"reminder_before\":null,\"date_range_formatted\":\"Wed, Sep 23, 2026 (all day)\",\"public_url\":\"http:\\\/\\\/addcal.co\\\/e\\\/p3mwubr0q8wt\",\"embed_url\":\"http:\\\/\\\/addcal.co\\\/e\\\/p3mwubr0q8wt\",\"location_url\":null,\"image_url\":null,\"timezone_readable\":null,\"calendar\":{\"uid\":\"fazboupkz9yi\",\"public_id\":\"cal_fazboupkz9yi\",\"short_link\":null,\"name\":\"eum et ipsum\",\"internal_name\":null,\"description\":\"

Non voluptates ipsa in qui. Non quibusdam est qui accusantium ut et. Non voluptate ea non non. Minima amet nesciunt et neque.<\\\/p>\",\"timezone\":\"Europe\\\/Copenhagen\",\"week_begins\":2,\"public_url\":\"http:\\\/\\\/addcal.co\\\/c\\\/fazboupkz9yi\",\"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\"}}", "name": "" } ] }, { "name": "Update RSVP", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars\/:calendar_public_id\/events\/:event_public_id\/rsvps\/:public_id", "query": [], "raw": "{{baseUrl}}\/api\/calendars\/:calendar_public_id\/events\/:event_public_id\/rsvps\/:public_id", "variable": [ { "id": "calendar_public_id", "key": "calendar_public_id", "value": "cal_p9v02qsz079d", "description": "The ID of the calendar public." }, { "id": "event_public_id", "key": "event_public_id", "value": "evt_2ksqz788l9h3", "description": "The ID of the event public." }, { "id": "public_id", "key": "public_id", "value": "rsvp_a1vwg8qt8o9n", "description": "The ID of the public." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"response_type\":\"et\",\"name\":\"nkazafyx\",\"email\":\"griffin.christiansen@example.net\",\"strict\":false}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"uid\":\"64637cd7-513b-4a9c-918c-932a00115331\",\"public_id\":\"rsvp_64637cd7-513b-4a9c-918c-932a00115331\",\"event_uid\":\"excd7jxfpsp5\",\"response_type\":\"yes\",\"name\":\"Jovan Labadie Jr.\",\"email\":\"orowe@rogahn.info\",\"data\":{\"guests\":3,\"comment\":\"Aut dolorem dolores qui in ut sunt nisi.\"},\"formatted_created_at\":\"2026-08-28 03:20:12\",\"created_at\":\"2026-08-28T03:20:12.000000Z\",\"updated_at\":\"2026-08-28T03:20:12.000000Z\",\"event\":{\"uid\":\"excd7jxfpsp5\",\"public_id\":\"evt_excd7jxfpsp5\",\"calendar_uid\":\"cal_xom05jal706d\",\"short_link\":null,\"title\":\"Culpa voluptatem dolores expedita.\",\"internal_name\":null,\"is_draft\":false,\"description\":\"

Itaque impedit pariatur pariatur consequatur sed doloremque. Nihil molestias esse ea ea ut. Tempore id sed ut mollitia et ut.<\\\/p>\\n\\n

Tempore sunt et corporis id. Dolorem aut eaque qui. Facilis molestias temporibus possimus ut. Voluptatum consequatur voluptas et nostrum a.<\\\/p>\",\"location\":\"6700 Hodkiewicz Prairie\\nDaynamouth, NE 39778\",\"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-08-20T21:46:09+02:00\",\"date_end\":\"2026-08-20T22:46:09+02:00\",\"timezone\":\"Africa\\\/Ceuta\",\"busy_type\":null,\"reminder_before\":null,\"date_range_formatted\":\"Thu, Aug 20, 2026 9:46 PM - 10:46 PM\",\"public_url\":\"http:\\\/\\\/addcal.co\\\/e\\\/excd7jxfpsp5\",\"embed_url\":\"http:\\\/\\\/addcal.co\\\/e\\\/excd7jxfpsp5\",\"location_url\":null,\"image_url\":null,\"timezone_readable\":\"CEST \\\/ GMT+02:00\",\"calendar\":{\"uid\":\"xom05jal706d\",\"public_id\":\"cal_xom05jal706d\",\"short_link\":null,\"name\":\"et et voluptas\",\"internal_name\":\"expedita voluptatibus cumque\",\"description\":\"\",\"timezone\":\"Europe\\\/Sarajevo\",\"week_begins\":0,\"public_url\":\"http:\\\/\\\/addcal.co\\\/c\\\/xom05jal706d\",\"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\"}}", "name": "" } ] }, { "name": "Delete RSVP", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars\/:calendar_public_id\/events\/:event_public_id\/rsvps\/:public_id", "query": [], "raw": "{{baseUrl}}\/api\/calendars\/:calendar_public_id\/events\/:event_public_id\/rsvps\/:public_id", "variable": [ { "id": "calendar_public_id", "key": "calendar_public_id", "value": "cal_p9v02qsz079d", "description": "The ID of the calendar public." }, { "id": "event_public_id", "key": "event_public_id", "value": "evt_2ksqz788l9h3", "description": "The ID of the event public." }, { "id": "public_id", "key": "public_id", "value": "rsvp_a1vwg8qt8o9n", "description": "The ID of the public." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Events > Invites", "description": "Send real calendar invites (iTIP\/iMIP) by email straight from your own integration.\n\nAn invite emails the attendee a native calendar request with Yes\/No\/Maybe buttons; accepting writes\nthe event into their primary calendar and their reply is tracked back on the invite. Calendar invites\nmust be enabled on the event (`has_calendar_invites`) for a team on the Business plan, otherwise\nthese endpoints return `403`.", "item": [ { "name": "Resend Invite by Email", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars\/:calendar_public_id\/events\/:event_public_id\/invites\/resend", "query": [], "raw": "{{baseUrl}}\/api\/calendars\/:calendar_public_id\/events\/:event_public_id\/invites\/resend", "variable": [ { "id": "calendar_public_id", "key": "calendar_public_id", "value": "cal_p9v02qsz079d", "description": "The ID of the calendar public." }, { "id": "event_public_id", "key": "event_public_id", "value": "evt_2ksqz788l9h3", "description": "The ID of the event public." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"john@example.com\",\"source\":\"api\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"public_id\":\"inv_7h0irrhi7u73\",\"event_uid\":\"xm6fikf4e38d\",\"email\":\"lockman.sigurd@example.net\",\"status\":\"pending\",\"source\":\"event_page\",\"sent_at\":null,\"responded_at\":null,\"cancelled_at\":null,\"created_at\":\"2026-08-28T03:20:12+00:00\",\"updated_at\":\"2026-08-28T03:20:12+00:00\"}}", "name": "" }, { "header": [], "code": 404, "body": "{\"message\": \"No invite found for that email address.\"}", "name": "Not found" } ] }, { "name": "Cancel Invite by Email", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars\/:calendar_public_id\/events\/:event_public_id\/invites\/cancel", "query": [], "raw": "{{baseUrl}}\/api\/calendars\/:calendar_public_id\/events\/:event_public_id\/invites\/cancel", "variable": [ { "id": "calendar_public_id", "key": "calendar_public_id", "value": "cal_p9v02qsz079d", "description": "The ID of the calendar public." }, { "id": "event_public_id", "key": "event_public_id", "value": "evt_2ksqz788l9h3", "description": "The ID of the event public." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"john@example.com\",\"source\":\"zapier\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 204, "body": null, "name": "Invite cancelled" }, { "header": [], "code": 404, "body": "{\"message\": \"No invite found for that email address.\"}", "name": "Not found" } ] }, { "name": "Resend Invite", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars\/:calendar_public_id\/events\/:event_public_id\/invites\/:invite_public_id\/resend", "query": [], "raw": "{{baseUrl}}\/api\/calendars\/:calendar_public_id\/events\/:event_public_id\/invites\/:invite_public_id\/resend", "variable": [ { "id": "calendar_public_id", "key": "calendar_public_id", "value": "cal_p9v02qsz079d", "description": "The ID of the calendar public." }, { "id": "event_public_id", "key": "event_public_id", "value": "evt_2ksqz788l9h3", "description": "The ID of the event public." }, { "id": "invite_public_id", "key": "invite_public_id", "value": "inv_s3id81ozhfq9", "description": "The ID of the invite public." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"public_id\":\"inv_5spu9i0901pe\",\"event_uid\":\"mllwqvcedxfn\",\"email\":\"brenden01@example.com\",\"status\":\"pending\",\"source\":\"event_page\",\"sent_at\":null,\"responded_at\":null,\"cancelled_at\":null,\"created_at\":\"2026-08-28T03:20:12+00:00\",\"updated_at\":\"2026-08-28T03:20:12+00:00\"}}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\": \"Cancelled invites cannot be resent.\"}", "name": "Cannot resend" } ] }, { "name": "Send Invite", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars\/:calendar_public_id\/events\/:event_public_id\/invites", "query": [], "raw": "{{baseUrl}}\/api\/calendars\/:calendar_public_id\/events\/:event_public_id\/invites", "variable": [ { "id": "calendar_public_id", "key": "calendar_public_id", "value": "cal_p9v02qsz079d", "description": "The ID of the calendar public." }, { "id": "event_public_id", "key": "event_public_id", "value": "evt_2ksqz788l9h3", "description": "The ID of the event public." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"john@example.com\",\"source\":\"api\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"public_id\":\"inv_ltilx76zq5x5\",\"event_uid\":\"cr2ws2a44oze\",\"email\":\"trantow.christopher@example.org\",\"status\":\"pending\",\"source\":\"event_page\",\"sent_at\":null,\"responded_at\":null,\"cancelled_at\":null,\"created_at\":\"2026-08-28T03:20:12+00:00\",\"updated_at\":\"2026-08-28T03:20:12+00:00\"}}", "name": "" }, { "header": [], "code": 403, "body": "{\"message\": \"Calendar invites are not enabled for this event.\"}", "name": "Invites not enabled" }, { "header": [], "code": 422, "body": "{\"message\": \"Sorry, this event has already ended.\"}", "name": "Event has ended" } ] }, { "name": "List Invites", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars\/:calendar_public_id\/events\/:event_public_id\/invites", "query": [ { "key": "status", "value": "sent", "description": "Filter by invite status (e.g. 'sent', 'accepted', 'declined')", "disabled": false }, { "key": "search", "value": "john@example.com", "description": "Search invites by email", "disabled": false }, { "key": "per_page", "value": "25", "description": "Number of results per page (1-100)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/calendars\/:calendar_public_id\/events\/:event_public_id\/invites?status=sent&search=john%40example.com&per_page=25", "variable": [ { "id": "calendar_public_id", "key": "calendar_public_id", "value": "cal_p9v02qsz079d", "description": "The ID of the calendar public." }, { "id": "event_public_id", "key": "event_public_id", "value": "evt_2ksqz788l9h3", "description": "The ID of the event public." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"status\":\"quos\",\"search\":\"jlful\",\"per_page\":10}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"public_id\":\"inv_bcusq2kzoiah\",\"event_uid\":\"h9zr80tdw7lw\",\"email\":\"keanu80@example.net\",\"status\":\"pending\",\"source\":\"event_page\",\"sent_at\":null,\"responded_at\":null,\"cancelled_at\":null,\"created_at\":\"2026-08-28T03:20:12+00:00\",\"updated_at\":\"2026-08-28T03:20:12+00:00\"},{\"public_id\":\"inv_ketaqoreawrc\",\"event_uid\":\"z1jwacosbo8s\",\"email\":\"tmarvin@example.org\",\"status\":\"pending\",\"source\":\"event_page\",\"sent_at\":null,\"responded_at\":null,\"cancelled_at\":null,\"created_at\":\"2026-08-28T03:20:12+00:00\",\"updated_at\":\"2026-08-28T03:20:12+00:00\"}]}", "name": "" } ] }, { "name": "Get Invite", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars\/:calendar_public_id\/events\/:event_public_id\/invites\/:public_id", "query": [], "raw": "{{baseUrl}}\/api\/calendars\/:calendar_public_id\/events\/:event_public_id\/invites\/:public_id", "variable": [ { "id": "calendar_public_id", "key": "calendar_public_id", "value": "cal_p9v02qsz079d", "description": "The ID of the calendar public." }, { "id": "event_public_id", "key": "event_public_id", "value": "evt_2ksqz788l9h3", "description": "The ID of the event public." }, { "id": "public_id", "key": "public_id", "value": "inv_s3id81ozhfq9", "description": "The ID of the public." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"public_id\":\"inv_fq81198ikx6u\",\"event_uid\":\"ozcmxa77y187\",\"email\":\"kihn.berniece@example.org\",\"status\":\"pending\",\"source\":\"event_page\",\"sent_at\":null,\"responded_at\":null,\"cancelled_at\":null,\"created_at\":\"2026-08-28T03:20:12+00:00\",\"updated_at\":\"2026-08-28T03:20:12+00:00\"}}", "name": "" } ] }, { "name": "Cancel Invite", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calendars\/:calendar_public_id\/events\/:event_public_id\/invites\/:public_id", "query": [], "raw": "{{baseUrl}}\/api\/calendars\/:calendar_public_id\/events\/:event_public_id\/invites\/:public_id", "variable": [ { "id": "calendar_public_id", "key": "calendar_public_id", "value": "cal_p9v02qsz079d", "description": "The ID of the calendar public." }, { "id": "event_public_id", "key": "event_public_id", "value": "evt_2ksqz788l9h3", "description": "The ID of the event public." }, { "id": "public_id", "key": "public_id", "value": "inv_s3id81ozhfq9", "description": "The ID of the public." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 204, "body": null, "name": "Invite cancelled" }, { "header": [], "code": 422, "body": "{\"message\": \"This invite is no longer active.\"}", "name": "Not active" } ] } ] }, { "name": "Account", "description": "APIs for managing the authenticated user's account", "item": [ { "name": "Get Current User", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/me", "query": [], "raw": "{{baseUrl}}\/api\/users\/me" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 200, "body": "{\"user\":{\"uid\":\"ta8ck2mzgfdv\",\"name\":\"Test User\",\"email\":\"test@example.com\",\"created_at\":\"2025-07-27T06:39:24.000000Z\",\"updated_at\":\"2026-08-28T00:02:40.000000Z\"},\"teams\":[{\"uid\":\"v08acy4z0l57\",\"name\":\"Email Limit Test (1990 used)\",\"personal_team\":false,\"is_owner\":true,\"is_subscribed\":true,\"timezone\":null,\"created_at\":\"2026-07-19T04:28:25.000000Z\",\"updated_at\":\"2026-07-19T04:28:25.000000Z\"},{\"uid\":\"vvmknusj2w7g\",\"name\":\"Email Limit Test (990 used)\",\"personal_team\":false,\"is_owner\":true,\"is_subscribed\":true,\"timezone\":null,\"created_at\":\"2026-07-19T04:28:25.000000Z\",\"updated_at\":\"2026-07-19T05:31:52.000000Z\"},{\"uid\":\"b9jftdrz6ad2\",\"name\":\"Test User's Team\",\"personal_team\":true,\"is_owner\":true,\"is_subscribed\":true,\"timezone\":null,\"created_at\":\"2025-07-27T06:39:24.000000Z\",\"updated_at\":\"2026-07-05T05:17:19.000000Z\"}],\"current_team\":{\"uid\":\"b9jftdrz6ad2\",\"name\":\"Test User's Team\",\"personal_team\":true,\"is_owner\":true,\"is_subscribed\":true,\"timezone\":null,\"created_at\":\"2025-07-27T06:39:24.000000Z\",\"updated_at\":\"2026-07-05T05:17:19.000000Z\"}}", "name": "" } ] } ] }, { "name": "Dynamic Links", "description": "Generate add-to-calendar redirect URLs from query parameters. Requires a Dynamic Link Key (Business plan). The user is redirected to their chosen calendar service with the event pre-filled.", "item": [ { "name": "GET api\/dyn", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/dyn", "query": [ { "key": "uid", "value": "dk_abc123", "description": "Your Dynamic Link Key identifier.", "disabled": false }, { "key": "service", "value": "google", "description": "Calendar service to redirect to. Accepted: google, apple, outlook, outlook_web, office365, yahoo, ics, manual.", "disabled": false }, { "key": "title", "value": "Team Standup", "description": "Event title. Max 255 characters.", "disabled": false }, { "key": "start", "value": "2026-06-15T14:00:00", "description": "Start date\/time in ISO 8601 format.", "disabled": false }, { "key": "end", "value": "2026-06-15T15:00:00", "description": "End date\/time in ISO 8601 format. Defaults to 1 hour after start if omitted.", "disabled": false }, { "key": "duration", "value": "60", "description": "Duration in minutes. Takes precedence over end.", "disabled": false }, { "key": "timezone", "value": "America\/New_York", "description": "IANA timezone. Required for timed events.", "disabled": false }, { "key": "all_day_event", "value": "", "description": "Set to true for all-day events.", "disabled": true }, { "key": "description", "value": "Impedit voluptatem et autem voluptatem aspernatur.", "description": "Event description. Max 2000 characters.", "disabled": false }, { "key": "location", "value": "enim", "description": "Physical address or virtual meeting URL. Max 255 characters.", "disabled": false }, { "key": "alarm", "value": "15", "description": "Reminder in minutes before the event.", "disabled": false }, { "key": "recurring", "value": "FREQ=WEEKLY;BYDAY=MO,WE,FR", "description": "RFC 5545 recurrence rule (RRULE).", "disabled": false }, { "key": "transp", "value": "OPAQUE", "description": "Busy status: OPAQUE (busy) or TRANSPARENT (free). Defaults to OPAQUE.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/dyn?uid=dk_abc123&service=google&title=Team%20Standup&start=2026-06-15T14%3A00%3A00&end=2026-06-15T15%3A00%3A00&duration=60&timezone=America%2FNew_York&all_day_event=&description=Impedit%20voluptatem%20et%20autem%20voluptatem%20aspernatur.&location=enim&alarm=15&recurring=FREQ%3DWEEKLY%3BBYDAY%3DMO%2CWE%2CFR&transp=OPAQUE" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"uid\":\"ut\",\"title\":\"vzwilwkuhzkmitz\",\"start\":\"2026-08-28T03:20:12\",\"end\":\"2027-11-15\",\"duration\":65,\"timezone\":\"Africa\\\/Khartoum\",\"description\":\"Illum cumque occaecati impedit in non non sed.\",\"location\":\"iwemjqgkzhvwhupodub\",\"alarm\":39,\"recurring\":\"voluptates\",\"transp\":\"OPAQUE\",\"service\":\"ducimus\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 302, "body": null, "name": "Redirects the user to the chosen calendar service with the event pre-filled." }, { "header": [], "code": 403, "body": null, "name": "Team is not on the Business plan." }, { "header": [], "code": 404, "body": null, "name": "Dynamic Link Key not found or inactive." }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 404, "body": "{\n \"message\": \"\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The provided Dynamic Link parameters were invalid.\"}", "name": "When validation fails (e.g. missing required params or unrecognised service)." } ] }, { "name": "GET api\/dyn_ade", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/dyn_ade", "query": [ { "key": "client", "value": "dk_abc123", "description": "AddEvent compatibility alias for uid. Your Dynamic Link Key identifier.", "disabled": false }, { "key": "service", "value": "google", "description": "Calendar service to redirect to. AddEvent values (outlookcom, stream) are automatically mapped. Accepted: google, apple, outlook, outlook_web, office365, yahoo, ics, manual.", "disabled": false }, { "key": "title", "value": "Team Standup", "description": "Event title. Max 255 characters.", "disabled": false }, { "key": "start", "value": "2026-06-15T14:00:00", "description": "Start date\/time in ISO 8601 format.", "disabled": false }, { "key": "end", "value": "2026-06-15T15:00:00", "description": "End date\/time in ISO 8601 format. Defaults to 1 hour after start if omitted.", "disabled": false }, { "key": "duration", "value": "60", "description": "Duration in minutes. Takes precedence over end.", "disabled": false }, { "key": "timezone", "value": "America\/New_York", "description": "IANA timezone. Required for timed events.", "disabled": false }, { "key": "all_day_event", "value": "", "description": "Set to true for all-day events.", "disabled": true }, { "key": "description", "value": "Fuga aut facere possimus qui.", "description": "Event description. Max 2000 characters.", "disabled": false }, { "key": "location", "value": "odio", "description": "Physical address or virtual meeting URL. Max 255 characters.", "disabled": false }, { "key": "alarm", "value": "15", "description": "Reminder in minutes before the event.", "disabled": false }, { "key": "recurring", "value": "FREQ=WEEKLY;BYDAY=MO,WE,FR", "description": "RFC 5545 recurrence rule (RRULE).", "disabled": false }, { "key": "transp", "value": "OPAQUE", "description": "Busy status: OPAQUE (busy) or TRANSPARENT (free). Defaults to OPAQUE.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/dyn_ade?client=dk_abc123&service=google&title=Team%20Standup&start=2026-06-15T14%3A00%3A00&end=2026-06-15T15%3A00%3A00&duration=60&timezone=America%2FNew_York&all_day_event=&description=Fuga%20aut%20facere%20possimus%20qui.&location=odio&alarm=15&recurring=FREQ%3DWEEKLY%3BBYDAY%3DMO%2CWE%2CFR&transp=OPAQUE" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"uid\":\"ipsa\",\"title\":\"qqtmuir\",\"start\":\"2026-08-28T03:20:12\",\"end\":\"2072-12-15\",\"duration\":20,\"timezone\":\"Europe\\\/Andorra\",\"description\":\"Voluptas inventore culpa voluptatibus consequatur sit eum sed.\",\"location\":\"wkgdiwzkj\",\"alarm\":75,\"recurring\":\"sapiente\",\"transp\":\"TRANSPARENT\",\"service\":\"voluptate\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 302, "body": null, "name": "Redirects the user to the chosen calendar service with the event pre-filled." }, { "header": [], "code": 403, "body": null, "name": "Team is not on the Business plan." }, { "header": [], "code": 404, "body": null, "name": "Dynamic Link Key not found or inactive." }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 404, "body": "{\n \"message\": \"\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The provided Dynamic Link parameters were invalid.\"}", "name": "When validation fails (e.g. missing required params or unrecognised service)." } ] } ] }, { "name": "Endpoints", "description": "", "item": [ { "name": "DELETE api\/extension\/token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/extension\/token", "query": [], "raw": "{{baseUrl}}\/api\/extension\/token" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST api\/events\/extract", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/events\/extract", "query": [], "raw": "{{baseUrl}}\/api\/events\/extract" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"text\":\"zlfuuwnfess\",\"timezone\":\"Africa\\\/Casablanca\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "key", "type": "string" } ] } }