We released an updated version of our API in November 2023. While these endpoints are still supported, they will be deprecated over the coming months, and so we reccommend using the new API going forward. Documentation for the updated calendar and event APIs can be found here: API v2 Documentation
The API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors.
All API access is over HTTPS. All data is received as JSON, including errors.
Data
Please URL encode all parameter values.
The API requires an API token to work.
Please sign in or
create an account to receive your
accounts API tokens.
Returns a list of calendars. The calendars are sorted by recently saved calendars appearing first.
$ curl https://www.addevent.com/api/v1/me/calendars/list/?token=token
$ curl https://www.addevent.com/api/v1/me/calendars/list/?token=USER-TOKEN-ID
Returns
{
"meta": {
"code": "200"
},
"calendars": [{
"id": "145161006114",
"uniquekey": "ic14",
"title": "Add our events to your calendar",
"description": "Select your calendar, and accept the calendar subscription notice. \n\nWhen accepted, all of our events will automatically appear in your calendar application or mobile device.",
"followers_active": "805",
"followers_total": "1427",
"events_total": "100",
"main_calendar": "false",
"template_id": "a20418bkd038dkO",
"link_short": "http:\/\/cal.ae\/eoadiew",
"link_long": "https:\/\/www.addevent.com\/calendar\/pg261852",
"custom_data": "",
"date_create": 1434422899,
"date_modified": 1477958407
}],
"paging": {
"previous": "",
"next": "https:\/\/www.addevent.com\/api\/v1\/me\/calendars\/list\/?token=USER-TOKEN-ID&page=2"
}
}
Creates a calendar. Returns the calendar created.
$ curl https://www.addevent.com/api/v1/me/calendars/create/?token=token&title=title&description=description
$ curl https://www.addevent.com/api/v1/me/calendars/create/?token=USER-TOKEN-ID&title=Add+our+events+to+your+calendar&description=Select+your+calendar%2C+and+accept+the+calendar+subscription+notice.+%0A%0AWhen+accepted%2C+all+of+our+events+will+automatically+appear+in+your+calendar+application+or+mobile+device.
Returns
{
"meta": {
"code": "200"
},
"calendar": {
"id": "14793391331949",
"uniquekey": "XC1949",
"title": "Add our events to your calendar",
"description": "Select your calendar, and accept the calendar subscription notice. \n\nWhen accepted, all of our events will automatically appear in your calendar application or mobile device.",
"timezone": "America/Los_Angeles",
"weekday_begin": "0",
"calendar_color": "2",
"palette_id": "",
"followers_active": "0",
"followers_total": "0",
"events_total": "0",
"template_id": "a20418bkd038dkO",
"template_embed_id": "",
"link_short": "http:\/\/cal.ae\/eoadiew",
"link_long": "https:\/\/www.addevent.com\/calendar\/pg261852",
"custom_data": "",
"date_create": 1479339133,
"date_modified": 1479339133
}
}
Save a calendar. Returns the calendar saved.
$ curl https://www.addevent.com/api/v1/me/calendars/save/?token=token&title=title&description=description&calendar_id=calendar_id
$ curl https://www.addevent.com/api/v1/me/calendars/save/?token=USER-TOKEN-ID&title=Add+our+events+to+your+calendar&description=Select+your+calendar%2C+and+accept+the+calendar+subscription+notice.+%0A%0AWhen+accepted%2C+all+of+our+events+will+automatically+appear+in+your+calendar+application+or+mobile+device.&calendar_id=14793391331949
Returns
{
"meta": {
"code": "200"
},
"calendar": {
"id": "14793391331949",
"uniquekey": "XC1949",
"title": "Add our events to your calendar",
"description": "Select your calendar, and accept the calendar subscription notice. \n\nWhen accepted, all of our events will automatically appear in your calendar application or mobile device.",
"timezone": "America/Los_Angeles",
"weekday_begin": "0",
"calendar_color": "2",
"palette_id": "",
"followers_active": "0",
"followers_total": "0",
"events_total": "0",
"template_id": "a20418bkd038dkO",
"template_embed_id": "",
"link_short": "http:\/\/cal.ae\/eoadiew",
"link_long": "https:\/\/www.addevent.com\/calendar\/pg261852",
"custom_data": "",
"date_create": 1479339133,
"date_modified": 1479342638
}
}
Delete a calendar. Returns a deletion status. Please notice. A "main calendar" can't be deleted.
$ curl https://www.addevent.com/api/v1/me/calendars/delete/?token=token&calendar_id=calendar_id
$ curl https://www.addevent.com/api/v1/me/calendars/delete/?token=USER-TOKEN-ID&calendar_id=14793391331949
Returns
{
"meta": {
"code": "200"
},
"calendar": {
"id": "14793391331949",
"status": "deleted"
}
}
Returns a list of events in a calendar. The events are sorted by recently created.
$ curl https://www.addevent.com/api/v1/me/calendars/events/list/?token=token&calendar_id=calendar_id
$ curl https://www.addevent.com/api/v1/me/calendars/events/list/?token=USER-TOKEN-ID&calendar_id=1473327868906
Returns
{
"meta": {
"code": "200"
},
"calendar": {
"id": "1473327868906",
"events_count": 33,
"link_short": "http:\/\/cal.ae\/eoadiew",
"link_long": "https:\/\/www.addevent.com\/calendar\/pg261852"
},
"events": [{
"id": "125163",
"unique": "db125163",
"title": "Title of the event",
"eventname": "Title of the event",
"description": "Description of the event",
"location": "1600 Amphitheatre Pkwy, Mountain View, CA 94043",
"organizer": "Thomas Scott",
"organizer_email": "thomas@example.com",
"date_start": "11\/21\/2024",
"date_start_time": "09:00:00",
"date_start_ampm": "AM",
"date_start_unix": 1732179600,
"date_end": "11\/21\/2024",
"date_end_time": "11:00:00",
"date_end_ampm": "AM",
"date_end_unix": 1732186800,
"all_day_event": "false",
"date_format": "MM\/DD\/YYYY",
"timezone": "America\/Los_Angeles",
"reminder": "60",
"rrule": "",
"template_id": "a20418bkd038dkO",
"color": "2",
"transp": "busy",
"custom_data": "",
"link_short": "",
"link_long": "https:\/\/www.addevent.com\/event\/xh5112744",
"date_create": 1732179600,
"date_modified": 1732179600,
"updated_times": "0"
}, {
"id": "125162",
"unique": "ae125162",
"title": "Title of the event",
"eventname": "Title of the event",
"description": "Description of the event",
"location": "1600 Amphitheatre Pkwy, Mountain View, CA 94043",
"organizer": "Thomas Scott",
"organizer_email": "thomas@example.com",
"date_start": "11\/14\/2024",
"date_start_time": "09:00:00",
"date_start_ampm": "AM",
"date_start_unix": 1731574800,
"date_end": "11\/14\/2024",
"date_end_time": "11:00:00",
"date_end_ampm": "AM",
"date_end_unix": 1731582000,
"all_day_event": "false",
"date_format": "MM\/DD\/YYYY",
"timezone": "America\/Los_Angeles",
"reminder": "60",
"rrule": "",
"template_id": "a20418bkd038dkO",
"color": "2",
"transp": "busy",
"custom_data": "",
"link_short": "",
"link_long": "https:\/\/www.addevent.com\/event\/xh5112744",
"date_create": 1731574800,
"date_modified": 1731574800,
"updated_times": "0"
}],
"paging": {
"previous": "",
"next": "https:\/\/www.addevent.com\/api\/v1\/me\/calendars\/events\/list\/?token=USER-TOKEN-ID&calendar_id=1473327868906&page=2"
}
}
Returns a list of all events across all calendars. The events are sorted by recently created.
$ curl https://www.addevent.com/api/v1/me/calendars/events/all/?token=token
$ curl https://www.addevent.com/api/v1/me/calendars/events/all/?token=USER-TOKEN-ID
Returns
{
"meta": {
"code": "200"
},
"events": [{
"id": "5546043",
"unique": "sm125163",
"title": "Title of the event",
"eventname": "Title of the event",
"description": "Description of the event",
"location": "1600 Amphitheatre Pkwy, Mountain View, CA 94043",
"organizer": "Thomas Scott",
"organizer_email": "thomas@example.com",
"date_start": "11\/21\/2024",
"date_start_time": "09:00:00",
"date_start_ampm": "AM",
"date_start_unix": 1732179600,
"date_end": "11\/21\/2024",
"date_end_time": "11:00:00",
"date_end_ampm": "AM",
"date_end_unix": 1732186800,
"all_day_event": "false",
"date_format": "MM\/DD\/YYYY",
"timezone": "America\/Los_Angeles",
"reminder": "60",
"rrule": "",
"template_id": "a20418bkd038dkO",
"color": "2",
"transp": "busy",
"custom_data": "",
"link_short": "",
"link_long": "https:\/\/www.addevent.com\/event\/xh5112744",
"date_create": 1732179600,
"date_modified": 1732179600,
"updated_times": "2",
"calendar_id": "145111006114",
"calendar_uniquekey": "ic14",
"calendar_title": "Demo calendar",
"calendar_name": "",
"calendar_followers_active": "3659",
"calendar_followers_total": "7599",
"calendar_events_total": "273",
"calendar_link_short": "http:\/\/cal.ae\/eoadiew",
"calendar_link_long": "https:\/\/www.addevent.com\/calendar\/pg261852",
"calendar_date_create": "2020-06-16 02:48:19",
"calendar_date_modified": "2024-10-09 18:58:19"
}, {
"id": "5546044",
"unique": "tx125164",
"title": "Title of the event",
"eventname": "Title of the event",
"description": "Description of the event",
"location": "1600 Amphitheatre Pkwy, Mountain View, CA 94043",
"organizer": "Thomas Scott",
"organizer_email": "thomas@example.com",
"date_start": "11\/21\/2024",
"date_start_time": "09:00:00",
"date_start_ampm": "AM",
"date_start_unix": 1732179600,
"date_end": "11\/21\/2024",
"date_end_time": "11:00:00",
"date_end_ampm": "AM",
"date_end_unix": 1732186800,
"all_day_event": "false",
"date_format": "MM\/DD\/YYYY",
"timezone": "America\/Los_Angeles",
"reminder": "60",
"rrule": "",
"template_id": "a20418bkd038dkO",
"color": "2",
"transp": "busy",
"custom_data": "",
"link_short": "",
"link_long": "https:\/\/www.addevent.com\/event\/xh5112744",
"date_create": 1732179600,
"date_modified": 1732179600,
"updated_times": "2",
"calendar_id": "145111006114",
"calendar_uniquekey": "ic14",
"calendar_title": "Demo calendar",
"calendar_name": "",
"calendar_followers_active": "3659",
"calendar_followers_total": "7599",
"calendar_events_total": "273",
"calendar_link_short": "http:\/\/cal.ae\/eoadiew",
"calendar_link_long": "https:\/\/www.addevent.com\/calendar\/pg261852",
"calendar_date_create": "2020-06-16 02:48:19",
"calendar_date_modified": "2024-10-09 18:58:19"
}],
"paging": {
"previous": "",
"next": "https:\/\/www.addevent.com\/api\/v1\/me\/calendars\/events\/all\/?token=USER-TOKEN-ID&page=2"
}
}
Creates an event in a calendar. Returns the event created.
$ curl https://www.addevent.com/api/v1/me/calendars/events/create/?token=token&calendar_id=calendar_id&title=title&description=description&location=location&organizer=organizer&organizer_email=organizer_email&timezone=timezone&reminder=reminder&start_date=start_date&end_date=end_date&all_day_event=all_day_event&custom_data=custom_data
$ curl https://www.addevent.com/api/v1/me/calendars/events/create/?token=USER-TOKEN-ID&calendar_id=1473327868906&title=Title+of+the+event&description=Description+of+the+event&location=1600+Amphitheatre+Pkwy%2C+Mountain+View%2C+CA+94043&organizer=Thomas+Scott&organizer_email=thomas%40example.com&timezone=America%2FLos_Angeles&reminder=60&start_date=01%2F07%2F2025+09%3A00&end_date=01%2F07%2F202511%3A00&all_day_event=false&custom_data=null
Returns
{
"meta": {
"code": "200"
},
"event": {
"id": 159051,
"calendar": "1473327868906",
"unique": "db125163",
"title": "Title of the event",
"description": "Description of the event",
"location": "1600 Amphitheatre Pkwy, Mountain View, CA 94043",
"organizer": "Thomas Scott",
"organizer_email": "thomas@example.com",
"date_start": null,
"date_start_time": "09:00:00",
"date_start_ampm": "AM",
"date_end": null,
"date_end_time": "11:00:00",
"date_end_ampm": "AM",
"all_day_event": "false",
"date_format": "MM\/DD\/YYYY",
"timezone": "America\/Los_Angeles",
"reminder": "60",
"rrule": "",
"template_id": "a20418bkd038dkO",
"color": "2",
"transp": "busy",
"custom_data": "null",
"updated_times": "0",
"link_short": "",
"link_long": "https:\/\/www.addevent.com\/event\/xh5112744",
"date_create": 1736240400,
"date_modified": 1736240400 }
}
Save an event in a calendar. Returns the event saved.
$ curl https://www.addevent.com/api/v1/me/calendars/events/save/?token=token&event_id=event_id&title=title&description=description&location=location&organizer=organizer&organizer_email=organizer_email&timezone=timezone&reminder=reminder&start_date=start_date&end_date=end_date&all_day_event=all_day_event&custom_data=custom_data
$ curl https://www.addevent.com/api/v1/me/calendars/events/save/?token=USER-TOKEN-ID&event_id=159051&title=Title+of+the+event&description=Description+of+the+event&location=1600+Amphitheatre+Pkwy%2C+Mountain+View%2C+CA+94043&organizer=Thomas+Scott&organizer_email=thomas%40example.com&timezone=America%2FLos_Angeles&reminder=60&start_date=01%2F07%2F2025+09%3A00&end_date=01%2F07%2F202511%3A00&all_day_event=false&custom_data=
Returns
{
"meta": {
"code": "200"
},
"event": {
"id": 159051,
"calendar": "1473327868906",
"unique": "db125163",
"title": "Title of the event",
"description": "Description of the event",
"location": "1600 Amphitheatre Pkwy, Mountain View, CA 94043",
"organizer": "Thomas Scott",
"organizer_email": "thomas@example.com",
"date_start": null,
"date_start_time": "09:00:00",
"date_start_ampm": "AM",
"date_end": "",
"date_end_time": "11:00:00",
"date_end_ampm": "AM",
"all_day_event": "false",
"date_format": "MM\/DD\/YYYY",
"timezone": "America\/Los_Angeles",
"reminder": "60",
"rrule": "",
"template_id": "a20418bkd038dkO",
"color": "2",
"transp": "busy",
"custom_data": "null",
"updated_times": "1",
"link_short": "",
"link_long": "https:\/\/www.addevent.com\/event\/xh5112744",
"date_create": 1736240400,
"date_modified": 1736240400 }
}
Deletes an event in a calendar. Returns a deletion status.
$ curl https://www.addevent.com/api/v1/me/calendars/events/delete/?token=token&event_id=event_id
$ curl https://www.addevent.com/api/v1/me/calendars/events/delete/?token=USER-TOKEN-ID&event_id=159051
Returns
{
"meta": {
"code": "200"
},
"event": {
"id": "159051",
"status": "deleted"
}
}
Returns a list of calendar subscribers. The subscribers are sorted by recently created.
$ curl https://www.addevent.com/api/v1/me/calendars/subscribers/list/?token=token&calendar_id=calendar_id
$ curl https://www.addevent.com/api/v1/me/calendars/subscribers/list/?token=USER-TOKEN-ID&calendar_id=14793391331949
Returns
{
"meta": {
"code": "200"
},
"summary": {
"subscribers_total": "41",
"subscribers_active": "32"
},
"calendar": {
"header": {
"active": "Active",
"blocked": "Blocked",
"userid": "ID",
"calendar": "Calendar",
"syncs": "Syncs",
"name": "Name",
"email": "Email",
"fld-iocbr": "My secret field",
"ip": "IP",
"city": "City",
"region": "Region",
"country": "Country",
"location": "Location",
"postal": "Postal",
"createdate": "Created",
"lastsyncdate": "Last sync date"
},
"subscribers": [{
"active": "Yes",
"blocked": "False",
"userid": "rt1602020946xb",
"calendar": "Google",
"syncs": "3",
"name": "",
"email": "",
"fld-iocbr": "",
"ip": "11.111.111.11",
"city": "San Francisco",
"region": "California",
"country": "US",
"location": "37.8376,-122.2398",
"postal": "94618",
"createdate": "Oct 6th 21:49pm (UTC)",
"lastsyncdate": "Oct 9th 05:04am (UTC)"
}
]
},
"paging": {
"previous": "",
"next": "https:\/\/www.addevent.com\/api\/me\/calendars\/subscribers\/list\/?token=USER-TOKEN-ID&calendar_id=14793391331949&page=2"
}
}
Sorting
$ curl https://www.addevent.com/api/v1/me/calendars/subscribers/list/?token=USER-TOKEN-ID&calendar_id=14793391331949&page=2
$ curl https://www.addevent.com/api/v1/me/calendars/subscribers/list/?token=USER-TOKEN-ID&calendar_id=14793391331949&page=2&status=inactive
$ curl https://www.addevent.com/api/v1/me/calendars/subscribers/list/?token=USER-TOKEN-ID&calendar_id=14793391331949&order=desc
Returns details about a subscriber.
$ curl https://www.addevent.com/api/v1/me/calendars/subscribers/subscriber/?token=token&calendar_id=calendar_id&user_id=user_id
$ curl https://www.addevent.com/api/v1/me/calendars/subscribers/subscriber/?token=USER-TOKEN-ID&calendar_id=14793391331949&user_id=wl150897869af
Returns
{
"meta": {
"code": "200"
},
"calendar": {
"header": {
"active": "Active",
"blocked": "Blocked",
"userid": "ID",
"calendar": "Calendar",
"syncs": "Syncs",
"name": "Name",
"email": "Email",
"fld-iocbr": "My secret field",
"ip": "IP",
"city": "City",
"region": "Region",
"country": "Country",
"location": "Location",
"postal": "Postal",
"createdate": "Created",
"lastsyncdate": "Last sync date"
},
"subscriber": {
"active": "Yes",
"blocked": "False",
"userid": "rm1392020946xb",
"calendar": "Google",
"syncs": "3",
"name": "",
"email": "",
"fld-iocbr": "",
"ip": "11.111.111.11",
"city": "Oakland",
"region": "California",
"country": "US",
"location": "37.8376,-122.2398",
"postal": "94618",
"createdate": "Oct 6th 2024 21:49pm (UTC)",
"lastsyncdate": "Oct 9th 2024 05:04am (UTC)"
}
}
}
Delete a calendar subscriber. Returns a deletion status.
$ curl https://www.addevent.com/api/v1/me/calendars/subscribers/subscriber/delete/?token=token&calendar_id=calendar_id&user_id=user_id
$ curl https://www.addevent.com/api/v1/me/calendars/subscribers/subscriber/delete/?token=USER-TOKEN-ID&calendar_id=14793391331949&user_id=wl150897869af
Returns
{
"meta": {
"code": "200"
},
"calendar": {
"subscriber": {
"userid": "rm1392020946xb",
"status": "deleted"
}
}
}
Lists of all available time zones.
$ curl https://www.addevent.com/api/v1/timezones
Returns
{
"meta": {
"code": 200
},
"data": [{
"label": "Africa/Abidjan",
"offset": "00:00"
}, {
"label": "Africa/Accra",
"offset": "00:00"
}]
}