AddEvent Calendars API
The Calendars API from AddEvent — 2 operation(s) for calendars.
The Calendars API from AddEvent — 2 operation(s) for calendars.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/addevent:addevent-calendars-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: v2.14.0
title: Calendar and Event Calendars API
contact:
name: AddEvent Inc
email: support@addevent.com
servers:
- url: https://api.addevent.com/calevent/v2
security:
- bearerAuth: []
tags:
- name: Calendars
paths:
/calendars:
post:
operationId: create-calendar
summary: Create a calendar
tags:
- Calendars
description: Creates a new calendar.
requestBody:
$ref: '#/components/requestBodies/calendar-create'
responses:
'201':
$ref: '#/components/responses/20x-calendar'
'400':
$ref: '#/components/responses/400-invalid-request-body'
get:
operationId: search-calendars
summary: Search calendars
tags:
- Calendars
description: Search for calendars you've previously created. Returns a search result object that contains a `calendar` property that contains an array of up to `page_size` calendars. If no calendars match the query, the resulting array will be empty.
parameters:
- $ref: '#/components/parameters/calendar-ids'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/page-size'
- $ref: '#/components/parameters/calendar-sort'
- $ref: '#/components/parameters/sort-order'
responses:
'200':
$ref: '#/components/responses/200-calendar-search'
'400':
$ref: '#/components/responses/400-invalid-query-parameters'
/calendars/{calendar_id}:
get:
operationId: retrieve-calendar
summary: Retrieve a calendar
tags:
- Calendars
description: Retrieves a calendar object.
parameters:
- $ref: '#/components/parameters/calendar-id'
responses:
'200':
$ref: '#/components/responses/20x-calendar'
'404':
$ref: '#/components/responses/404-not-found'
patch:
operationId: update-calendar
summary: Update a calendar
tags:
- Calendars
description: Updates a calendar by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts mostly the same properties as the calendar creation call.
parameters:
- $ref: '#/components/parameters/calendar-id'
requestBody:
$ref: '#/components/requestBodies/calendar-update'
responses:
'200':
$ref: '#/components/responses/20x-calendar'
'400':
$ref: '#/components/responses/400-invalid-request-body'
'404':
$ref: '#/components/responses/404-not-found'
delete:
operationId: delete-calendar
summary: Delete a calendar
tags:
- Calendars
description: Permenantly deletes a calendar. It cannot be undone.
parameters:
- $ref: '#/components/parameters/calendar-id'
responses:
'204':
$ref: '#/components/responses/204-deleted'
'404':
$ref: '#/components/responses/404-not-found'
components:
responses:
400-invalid-request-body:
description: Bad request
content:
application/json:
schema:
type: object
properties:
error_id:
type: string
description: A UUID which can be used to troubleshoot the error.
error_message:
type: string
description: Additional information about the error.
property_validation_errors:
type: array
items:
type: object
properties:
name:
type: string
reason:
type: string
description: An array of invalid property names, and the associated reason that the property is invalid.
examples:
Invalid request body:
$ref: '#/components/examples/invalid-request-body'
204-deleted:
description: Deleted successfully
400-invalid-query-parameters:
description: Bad request
content:
application/json:
schema:
type: object
properties:
error_id:
type: string
description: A UUID which can be used to troubleshoot the error.
error_message:
type: string
description: Additional information about the error.
property_validation_errors:
type: array
items:
type: object
properties:
name:
type: string
reason:
type: string
description: An array of invalid parameter names, and the associated reason that the property is invalid.
examples:
Invalid query parameters:
$ref: '#/components/examples/invalid-query-parameters'
404-not-found:
description: Not found
200-calendar-search:
description: Ok
content:
application/json:
schema:
type: object
properties:
pagination:
$ref: '#/components/schemas/pagination'
links:
$ref: '#/components/schemas/links'
calendars:
type: array
items:
$ref: '#/components/schemas/calendar'
examples:
Search results:
$ref: '#/components/examples/calendar-search'
20x-calendar:
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/calendar'
examples:
Calendar:
$ref: '#/components/examples/calendar-all'
examples:
calendar-all:
value:
id: 1701121309493871
unique_key: 1d493871
title: Calendar title
internal_name: ''
description: ''
is_default_calendar: true
timezone: America/Los_Angeles
weekday_begin: sunday
calendar_color: 1
palette_id: default
landing_page_template_id: default
embeddable_calendar_template_id: default
stats:
subscribers_active_count: 25
subscribers_all_count: 32
events_count: 12
created: '2023-08-20 21:41:48'
modified: '2023-11-27 21:43:17'
link_long: https://www.addevent.dev/calendar/1d493871
link_short: https://cal.ae/usgdhaw
custom_data: {}
invalid-query-parameters:
value:
error_message: Attribute Validation Error
invalid_param_responses:
- name: sort_by
reason: Invalid sorting field provided
error_id: 1-655f6e3c-2597d3171a91c593213d3e40
calendar-search:
value:
pagination:
current_page: 1
next_page: 1
previous_page: 1
total_items: 1
total_pages: 1
page_size: 10
links:
next_page_url: https://api.addevent.com/calevent/v2/calendars&page=1
previous_page_url: https://api.addevent.com/calevent/v2/calendars&page=1
calendars:
- $ref: '#/components/examples/calendar-all/value'
invalid-request-body:
value:
error_message: There are a number of validation errors with the request
error_id: 00c3317d-ecdc-449d-84f5-8562bc1ff831
property_validation_errors:
- name: rrule
reason: Not a valid RRule value
- name: title
reason: Cannot have blank value
requestBodies:
calendar-create:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/calendar-input'
required:
- title
calendar-update:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/calendar-input'
parameters:
page:
name: page
in: query
schema:
type: integer
minimum: 1
default: 1
description: Page number of the search results. The first page of results is `page=1`.
page-size:
name: page_size
in: query
schema:
type: integer
minimum: 1
maximum: 20
default: 10
description: A limit on the number of objects to be returned. `page_size` must be between 1 and 20, and the default is 10.
calendar-ids:
name: calendar_ids
in: query
style: form
explode: false
schema:
type: array
items:
type: string
pattern: ^\S+$
description: Comma-separated list of calendar IDs. Limits search results to those specific calendars.
calendar-id:
name: calendar_id
in: path
required: true
schema:
type: string
pattern: ^\S+$
description: Unique identifier for the calendar.
sort-order:
name: sort_order
in: query
schema:
type: string
enum:
- asc
- desc
default: desc
description: The order of the returned search results, sorted by the property specified in `sort_by`. Allowed values are `asc` or `desc`. If `sort_order` is provided, then `sort_by` must also be provided.
calendar-sort:
name: sort_by
in: query
schema:
type: string
enum:
- created
- title
default: created
description: The calendar property to sort by. Allowed values are `created`, or `title`. If `sort_order` is provided, then `sort_by` must also be provided.
schemas:
calendar-input:
type: object
properties:
title:
type: string
pattern: ^(?!\s*$).+
description: The calendar's title. It must be a non-empty, single-line string.
timezone:
type: string
pattern: ^(?!\s*$).+
default: America/Los_Angeles
description: 'The default timezone for events created on this calendar. The `List timezones` endpoint returns all of the timezone values that are supported, or you can use our <a href="https://www.addevent.com/c/documentation/tools/time-zone-lookup" target="_blank">Timezone Lookup Tool</a> to find a timezone. Defaults to `America/Los_Angeles`.
'
weekday_begin:
type: string
enum:
- sunday
- monday
default: sunday
description: The day of the week that the calendar starts on. Values are `sunday` or `monday`.
description:
type: string
description: The calendar's description. This appears on the calendar landing page and can be used to display additional information to users about the calendar. Accepts plain text and simplified HTML.
internal_name:
type: string
description: An internal name for the calendar which will not be displayed publicly. This can be used internally to distinguish between calendars, to add additional information/context to a calendar, or to store an external ID that relates to another system.
calendar_color:
type: integer
minimum: 1
maximum: 20
default: 1
description: The color of the calendar. This appears in the dashboard. Accepts values between `1` and `20` that correspond to the colors on the calendar's palette.
landing_page_template_id:
type: string
pattern: ^(?!\s*$).+
default: default
description: The ID of the custom calendar landing page template to associate with the calendar. Accepts the value `default`, which uses the standard AddEvent template, or the ID of a custom template, which can be retrieved with the `List calendar templates` endpoint.
embeddable_calendar_template_id:
type: string
pattern: ^(?!\s*$).+
default: default
description: The ID of the custom embeddable calendar template to associate with the calendar. Accepts the value `default`, which uses the standard AddEvent template, or the ID of a custom template, which can be retrieved with the `List calendar templates` endpoint.
custom_data:
type: object
description: Arbitary key-value pairs that can be attached to a calendar. Useful for storing additional structured data on an object, for example, storing external IDs to link a calendar to another system or linking to custom images for each calendar.
calendar:
type: object
properties:
id:
type: string
description: Unique identifier for the calendar.
unique_key:
type: string
description: A public identifier for the calendar that is used for sharing the calendar.
title:
type: string
description: The calendar's title.
timezone:
type: string
description: The default timezone for events on the calendar.
weekday_begin:
type: string
description: Day of the week that the calendar begins on. Values are `sunday` or `monday`.
is_default_calendar:
type: boolean
description: Whether the calendar is the default calendar on the account.
description:
type: string
description: The calendar's description. This appears on the calendar landing page.
internal_name:
type: string
description: An internal name for the calendar. This will not be displayed publicly.
calendar_color:
type: integer
description: The color of the calendar which appears in the dashboard. Values are between `1` and `20` and correspond to the colors on the calendar's palette.
palette_id:
type: string
description: The ID of the custom color palette that is associated with the calendar. The value `default` indicates that the standard AddEvent palette is being used.
landing_page_template_id:
type: string
description: The ID of the custom calendar landing page template that is associated with the calendar. The value `default` indicates that the standard AddEvent template is being used.
embeddable_calendar_template_id:
type: string
description: The ID of the custom embeddable calendar template that is associated with the calendar. The value `default` indicates that the standard AddEvent template is being used.
stats:
$ref: '#/components/schemas/calendar-stats'
custom_data:
type: object
description: Arbitary key-value pairs that can be attached to a calendar. Useful for storing additional structured data on an object, for example, storing external IDs to link a calendar to another system or linking to custom images for each calendar.
link_long:
type: string
description: The public URL to the calendar landing page. Used for sharing the calendar.
link_short:
type: string
description: The public short URL to the calendar landing page. Used for sharing the calendar.
created:
type: string
description: Time at which the calendar was created.
modified:
type: string
description: Time at which the calendar was last updated.
links:
type: object
properties:
next_page_url:
type: string
description: Link to the next page of search results.
previous_page_url:
type: string
description: Link to the previous page of search results.
description: Links to additional search results.
calendar-stats:
type: object
properties:
subscriber_active_count:
type: integer
description: The number of active subscribers on the calendar. An active subscriber means that the calendar feed has synced within the last 30 days.
subscribers_all_count:
type: integer
description: The total number of subscribers on the calendar. This includes all active subscribers, as well as inactive subscribers (which means that the calendar feed has not synced within the last 30 days), and calendar subscribers who were manually blocked by the calendar owner.
events_count:
type: integer
description: The total number of events on the calendar.
pagination:
type: object
properties:
current_page:
type: integer
description: Page number of the current page of search results.
next_page:
type: integer
description: Page number of the next page of search results.
previous_page:
type: integer
description: Page number of the previous page of search results.
total_items:
type: integer
description: The total number of objects in the search results.
total_pages:
type: integer
description: The total number of pages of search results.
page_size:
type: integer
description: The number of search results per page
description: Meta data about the search results and paging.
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: APIkey
description: Your API key can be found on your AddEvent account page - https://dashboard.addevent.com/account/settings
x-provenance:
method: searched
source: https://docs.addevent.com/reference
harvested: '2026-10-27'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://docs.addevent.com/reference/create-calendar.md
- https://docs.addevent.com/reference/create-event.md
- https://docs.addevent.com/reference/create-rsvp-attendee.md
- https://docs.addevent.com/reference/delete-calendar-subscriber.md
- https://docs.addevent.com/reference/delete-calendar.md
- https://docs.addevent.com/reference/delete-event.md
- https://docs.addevent.com/reference/delete-rsvp-attendee.md
- https://docs.addevent.com/reference/list-calendar-templates.md
- https://docs.addevent.com/reference/list-event-templates.md
- https://docs.addevent.com/reference/list-rsvp-forms.md
- https://docs.addevent.com/reference/list-timezones.md
- https://docs.addevent.com/reference/retrieve-calendar-subscriber.md
- https://docs.addevent.com/reference/retrieve-calendar.md
- https://docs.addevent.com/reference/retrieve-event.md
- https://docs.addevent.com/reference/retrieve-rsvp-attendee.md
- https://docs.addevent.com/reference/search-calendar-subscribers.md
- https://docs.addevent.com/reference/search-calendars.md
- https://docs.addevent.com/reference/search-events.md
- https://docs.addevent.com/reference/search-rsvp-attendees.md
- https://docs.addevent.com/reference/update-calendar.md
- https://docs.addevent.com/reference/update-event.md
- https://docs.addevent.com/reference/update-rsvp-attendee.md
merge:
pages: 22
deduped: 129
conflicts_kept_first: 0