Calendar API

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.

lock_open

List calendars

Returns a list of calendars. The calendars are sorted by recently saved calendars appearing first.

label
$ curl https://www.addevent.com/api/v1/me/calendars/list/?token=token
									
$ curl https://www.addevent.com/api/v1/me/calendars/list/?token=API-TOKEN										

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",
									       "date_create": 1434422899,
									       "date_modified": 1477958407
									   }],
									   "paging": {
									       "previous": "",
									       "next": "https:\/\/www.addevent.com\/api\/v1\/me\/calendars\/list\/?token=API-TOKEN&page=2"
									   }
									}
									
Parameter
Description
token
Required

Account token. The account token is available in the Account section and is incorporated in all code examples on this page.

Create a calendar

Creates a calendar. Returns the calendar created.

label
$ 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=API-TOKEN&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.",
									       "followers_active": "0",
									       "followers_total": "0",
									       "events_total": "0",
									       "template_id": "a20418bkd038dkO",
									       "link_short": "http:\/\/cal.ae\/eoadiew",
									       "link_long": "https:\/\/www.addevent.com\/calendar\/pg261852",
									       "date_create": 1479339133,
									       "date_modified": 1479339133
									   }
									}
									
Parameter
Description
token
Required

Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
title
Required

Title of the event. Single line string.
description
Description of the calendar. Use \n to separate lines. The field accepts plain text.

The description is used on the calendars subscribe page, e.g. https://www.addevent.com/calendar/ic14.
template_id
ID of a "Custom Calendar Page" template, e.g. "a20418bkd038dkO". Uses the "AddEvent default" template if template_id is not defined. In order to create/access custom templates please go to the Custom Templates for calendars page.

Save a calendar

Save a calendar. Returns the calendar saved.

label
$ 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=API-TOKEN&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.",
									       "followers_active": "0",
									       "followers_total": "0",
									       "events_total": "0",
									       "template_id": "a20418bkd038dkO",
									       "link_short": "http:\/\/cal.ae\/eoadiew",
									       "link_long": "https:\/\/www.addevent.com\/calendar\/pg261852",
									       "date_create": 1479339133,
									       "date_modified": 1479342638
									   }
									}
									
Parameter
Description
token
Required

Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
calendar_id
Required

Id of the calendar to save.
title
Required

Title of the event. Single line string.
description
Description of the calendar. Use \n to separate lines. The field accepts plain text.

The description is used on the calendars subscribe page, e.g. https://www.addevent.com/calendar/ic14.
template_id
ID of a "Custom Calendar Page" template, e.g. "a20418bkd038dkO". Uses the "AddEvent default" template if template_id is not defined. In order to create/access custom templates please go to the Custom Templates for calendars page.

Delete a calendar

Delete a calendar. Returns a deletion status. Please notice. A "main calendar" can't be deleted.

label
$ 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=API-TOKEN&calendar_id=14793391331949
										

Returns

{
									   "meta": {
									       "code": "200"
									   },
									   "calendar": {
									       "id": "14793391331949",
									       "status": "deleted"
									   }
									}
									
Parameter
Description
token
Required

Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
calendar_id
Required

Id of the calendar to delete.

List events in a calendar

Returns a list of events in a calendar. The events are sorted by recently created.

label
$ 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=API-TOKEN&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": "03\/21\/2021",
									       "date_start_time": "09:00:00",
									       "date_start_ampm": "AM",
									       "date_start_unix": 1616317200,
									       "date_end": "03\/21\/2021",
									       "date_end_time": "11:00:00",
									       "date_end_ampm": "AM",
									       "date_end_unix": 1616324400,
									       "all_day_event": "false",
									       "date_format": "MM\/DD\/YYYY",
									       "timezone": "",
									       "reminder": "60",
									       "rrule": "",
									       "template_id": "a20418bkd038dkO",
									       "color": "2",
									       "custom_data": "%7B%22name%22%3A%22Michael%22%2C%22bannerimage%22%3A%22https%3A%2F%2Fexample.org%2F...%2Fbanner1.jpg%22%7D",
									       "link_short": "https:\/\/evt.to\/iaaehuuw",
									       "link_long": "https:\/\/www.addevent.com\/event\/xh5112744",
									       "date_create": 1616317200,
									       "date_modified": 1616317200,
									       "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": "03\/14\/2021",
									       "date_start_time": "09:00:00",
									       "date_start_ampm": "AM",
									       "date_start_unix": 1615712400,
									       "date_end": "03\/14\/2021",
									       "date_end_time": "11:00:00",
									       "date_end_ampm": "AM",
									       "date_end_unix": 1615719600,
									       "all_day_event": "false",
									       "date_format": "MM\/DD\/YYYY",
									       "timezone": "",
									       "reminder": "60",
									       "rrule": "",
									       "template_id": "a20418bkd038dkO",
									       "color": "2",
									       "custom_data": "%7B%22name%22%3A%22Michael%22%2C%22bannerimage%22%3A%22https%3A%2F%2Fexample.org%2F...%2Fbanner1.jpg%22%7D",
									       "link_short": "https:\/\/evt.to\/iaaehuuw",
									       "link_long": "https:\/\/www.addevent.com\/event\/xh5112744",
									       "date_create": 1615712400,
									       "date_modified": 1615712400,
									       "updated_times": "0"
									   }],
									   "paging": {
									       "previous": "",
									       "next": "https:\/\/www.addevent.com\/api\/v1\/me\/calendars\/events\/list\/?token=API-TOKEN&calendar_id=1473327868906&page=2"
									   }
									}
									
Parameter
Description
token
Required

Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
calendar_id
Required

Id of the calendar.
order_by
List events in the calendar in a specific order.
Accepts: date-asc or date-desc or id-asc or id-desc

Example: &order_by=date-desc
month + year
List events in the calendar in a specific month of the year.
Accepts: month combined with year. Month must contain two digits (from 01-12) and year must contain four digits, e.g. "2021".

Example: &month=06&year=2021
upcoming
List upcoming events in the calendar from "now" or from a specific date/time value. Please notice: This parameter set "order_by" to "date-asc" by default. Accepts: now or a date/time. Date/time can be the following format: "2021-11-31 17:30:00" or "31-11-2021 11:00:00" or "2021/11/31 09:37am" or "11/31/2021 03:05pm".

Example: &upcoming=now" or "&upcoming=2021/11/31 12:01pm
search
Limits the results based on a keyword. Performs a wildcard search in these event fields: Title of the event, Internal name of the event, Description of the event, Location of the event

Example: &search=Hello+World"
json_field + json_value
Matches results based on data in the "custom_data" field.

If you have added custom data like e.g. {"tag":"company"} you are able to filter events by setting the parameter "json_field" to "tag" and look for the value "company".

Example: &json_field=tag&json_value=company

List all events across all calendars

Returns a list of all events across all calendars. The events are sorted by recently created.

label
$ 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=API-TOKEN										

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": "03\/21\/2021",
									       "date_start_time": "09:00:00",
									       "date_start_ampm": "AM",
									       "date_start_unix": 1616317200,
									       "date_end": "03\/21\/2021",
									       "date_end_time": "11:00:00",
									       "date_end_ampm": "AM",
									       "date_end_unix": 1616324400,
									       "all_day_event": "false",
									       "date_format": "MM\/DD\/YYYY",
									       "timezone": "",
									       "reminder": "60",
									       "rrule": "",
									       "template_id": "a20418bkd038dkO",
									       "color": "2",
									       "custom_data": "%7B%22name%22%3A%22Michael%22%2C%22bannerimage%22%3A%22https%3A%2F%2Fexample.org%2F...%2Fbanner1.jpg%22%7D",
									       "link_short": "https:\/\/evt.to\/iaaehuuw",
									       "link_long": "https:\/\/www.addevent.com\/event\/xh5112744",
									       "date_create": 1616317200,
									       "date_modified": 1616317200,
									       "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": "2021-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": "03\/21\/2021",
									       "date_start_time": "09:00:00",
									       "date_start_ampm": "AM",
									       "date_start_unix": 1616317200,
									       "date_end": "03\/21\/2021",
									       "date_end_time": "11:00:00",
									       "date_end_ampm": "AM",
									       "date_end_unix": 1616324400,
									       "all_day_event": "false",
									       "date_format": "MM\/DD\/YYYY",
									       "timezone": "",
									       "reminder": "60",
									       "rrule": "",
									       "template_id": "a20418bkd038dkO",
									       "color": "2",
									       "custom_data": "%7B%22name%22%3A%22Michael%22%2C%22bannerimage%22%3A%22https%3A%2F%2Fexample.org%2F...%2Fbanner1.jpg%22%7D",
									       "link_short": "https:\/\/evt.to\/iaaehuuw",
									       "link_long": "https:\/\/www.addevent.com\/event\/xh5112744",
									       "date_create": 1616317200,
									       "date_modified": 1616317200,
									       "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": "2021-10-09 18:58:19"
									   }],
									   "paging": {
									       "previous": "",
									       "next": "https:\/\/www.addevent.com\/api\/v1\/me\/calendars\/events\/all\/?token=API-TOKEN&page=2"
									   }
									}
									
Parameter
Description
token
Required

Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
order_by
List events in the calendar in a specific order.
Accepts: date-asc or date-desc or id-asc or id-desc or calendar-id-asc or calendar-id-desc

Example: &order_by=date-desc
month + year
List events in the calendar in a specific month of the year.
Accepts: month combined with year. Month must contain two digits (from 01-12) and year must contain four digits, e.g. "2021".

Example: &month=06&year=2021
upcoming
List upcoming events in the calendar from "now" or from a specific date/time value. Please notice: This parameter set "order_by" to "date-asc" by default. Accepts: now or a date/time. Date/time can be the following format: "2021-11-31 17:30:00" or "31-11-2021 11:00:00" or "2021/11/31 09:37am" or "11/31/2021 03:05pm".

Example: &upcoming=now" or "&upcoming=2021/11/31 12:01pm
cals_only
List only events in specified calendars. Accepts: calendar_id of the calendar. Separate multiple calendars with a comma ",".

Example: &cals_only=145111006114" or "&cals_only=145111006114,145111006115
search
Limits the results based on a keyword. Performs a wildcard search in these event fields: Title of the event, Internal name of the event, Description of the event, Location of the event

Example: &search=Hello+World"
json_field + json_value
Matches results based on data in the "custom_data" field.

If you have added custom data like e.g. {"tag":"company"} you are able to filter events by setting the parameter "json_field" to "tag" and look for the value "company".

Example: &json_field=tag&json_value=company

Create an event in a calendar

Creates an event in a calendar. Returns the event created.

label
$ 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=API-TOKEN&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=%3C%3Fphp+echo+%3B+%3F%3E&reminder=60&start_date=04%2F25%2F2021+09%3A00&end_date=04%2F25%2F202111%3A00&all_day_event=false&custom_data="{\"name\":\"Michael\",\"bannerimage\":\"https:\/\/example.org\/...\/banner1.jpg\"}"										

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": "04\/25\/2021",
									       "date_start_time": "09:00:00",
									       "date_start_ampm": ""AM"",
									       "date_end": "04\/25\/2021",
									       "date_end_time": "11:00:00",
									       "date_end_ampm": ""AM"",
									       "all_day_event": "false",
									       "date_format": "MM\/DD\/YYYY",
									       "timezone": "",
									       "reminder": "60",
									       "rrule": "",
									       "template_id": "a20418bkd038dkO",
									       "color": "2",
									       "custom_data": ""{\"name\":\"Michael\",\"bannerimage\":\"https:\/\/example.org\/...\/banner1.jpg\"}"",
									       "updated_times": "0",
									       "link_short": "https:\/\/evt.to\/iaaehuuw",
									       "link_long": "https:\/\/www.addevent.com\/event\/xh5112744",
									       "date_create": 1619341200,
									       "date_modified": 1619341200 
									   }
									}
									
Parameter
Description
token
Required

Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
calendar_id
Required

Id of the calendar to create the event in.
title
Required

Title of the event. Single line string.
description
Description of the event. Use \n to separate lines. The field accepts plain text.
location
Location of the event, e.g. "1600 Amphitheatre Pkwy, Mountain View, CA 94043".
organizer
Event organizer, e.g. "Thomas Scott".

If you fill out organizer you must also include the organizer_email field.

If you include an organizer and an organizer_email, the event is considered to be a "meeting" by calendar clients like Outlook. If you don't include the fields, the event is considered to be an "appointment".
organizer_email
Event organizer e-mail, e.g. "thomas@example.com".

If you fill out organizer_email you must also include the organizer field.

If you include an organizer and an organizer_email, the event is considered to be a "meeting" by calendar clients like Outlook. If you don't include the fields, the event is considered to be an "appointment".
start_date
Required

Start date of the event. Accepts most date/time formats, e.g. 04/11/2021 03:00 PM (12-hour format) or 11-04-2021 15:00 (24-hour format).

Use numeric values to describe the date, e.g. "04/25/2021" and not textual, e.g. "April 25th, 2021".

Dates in the m/d/y or d-m-y formats are disambiguated by looking at the separator between the various components: if the separator is a slash (/), then the American m/d/y is assumed; whereas if the separator is a dash (-) or a dot (.), then the European d-m-y format is assumed. If, however, the year is given in a two digit format and the separator is a dash (-, the date string is parsed as y-m-d. To avoid potential ambiguity, it's best to use ISO 8601 (YYYY-MM-DD) dates

Date examples:
04/11/2021 03:00 PM or 11-04-2021 15:00 or 2021/04/11 03:00 PM or 2021-04-11 15:00
end_date
End date of the event. Accepts most date/time formats, e.g. 04/11/2021 05:00 PM (12-hour format) or 11-04-2021 17:00 (24-hour format).

Use numeric values to describe the date, e.g. "04/25/2021" and not textual, e.g. "April 25th, 2021".

Dates in the m/d/y or d-m-y formats are disambiguated by looking at the separator between the various components: if the separator is a slash (/), then the American m/d/y is assumed; whereas if the separator is a dash (-) or a dot (.), then the European d-m-y format is assumed. If, however, the year is given in a two digit format and the separator is a dash (-, the date string is parsed as y-m-d. To avoid potential ambiguity, it's best to use ISO 8601 (YYYY-MM-DD) dates

Date examples:
04/11/2021 05:00 PM or 11-04-2021 17:00 or 2021/04/11 05:00 PM or 2021-04-11 17:00

If end is not defined, the end date is automatically set to start date plus one hour.
timezone
Required

The events time zone, e.g. Europe/Paris or .

The timezone parameter converts the date/time to Zulu time / GMT / UTC. The timezone parameter defaults to "" if a timezone is not defined.

You can find a list of all time zones (Section: List of time zones) at the bottom of this page.

Explanation: The timezone parameter makes sure the date/time is correct no matter if you are in New York or Sydney.
all_day_event
All day event. Accepts true or false.
reminder
Event reminder. Trigger an event reminder e.g. "15" minutes before the event starts.
Accepted input: Number

Example: Reminder "15" minutes before event starts = 15 or
one day before event starts : 60 minutes x 24 hours = 1440.

Event reminders are currently supported by:
- Apple Calendar
- Outlook
rrule
Recurring rule, e.g. FREQ=WEEKLY;UNTIL=20211110T080000Z;BYDAY=WE,TH,FR Make the event repeat for a number of times.

Generate Recurring Rulebuild

Recurring rules are advanced and needs to be tested before you publish it. Please notice: The start date/time must match the recurrence rule in order to work in strict calendar systems like Outlook and Apple Calendar.

Recurring rules are currently supported by:
- Apple Calendar
- Google Calendar (using "Direct" and Google Events API)
- Office 365 (using the Microsoft Events API)
- Outlook
- Outlook.com (using Microsoft Events API)
template_id
ID of a "Custom Event Page" template, e.g. "a20418bkd038dkO". Uses the "AddEvent default" template if template_id is not defined. In order to create/access custom templates please go to the Custom Templates for events page.
custom_data
Allows you to save a JSON string containing keys and values which can be used with a custom event templates.

E.g. {"name":"Michael","bannerimage":"https://example.org/.../banner1.jpg"}

The system will collect the keys in the JSON string and make the keys/values available in the template markup.

E.g. use {{name}} or {{bannerimage}} to output the variables in your custom template.

Requires valid JSON. Max length of JSON string is 500 characters.
color
Color of the event as pre-defined in the calendar settings. Accepts 1 to 20.

Save an event in a calendar

Save an event in a calendar. Returns the event saved.

label
$ 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=API-TOKEN&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=%3C%3Fphp+echo+%3B+%3F%3E&reminder=60&start_date=04%2F25%2F2021+09%3A00&end_date=04%2F25%2F202111%3A00&all_day_event=false&custom_data=%7B%22name%22%3A%22Michael%22%2C%22bannerimage%22%3A%22https%3A%2F%2Fexample.org%2F...%2Fbanner1.jpg%22%7D										

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": "04\/25\/2021",
									       "date_start_time": "09:00:00",
									       "date_start_ampm": "AM",
									       "date_end": "04\/25\/2021",
									       "date_end_time": "11:00:00",
									       "date_end_ampm": "AM",
									       "all_day_event": "false",
									       "date_format": "MM\/DD\/YYYY",
									       "timezone": "",
									       "reminder": "60",
									       "rrule": "",
									       "template_id": "a20418bkd038dkO",
									       "color": "2",
									       "custom_data": ""{\"name\":\"Michael\",\"bannerimage\":\"https:\/\/example.org\/...\/banner1.jpg\"}"",
									       "updated_times": "1",
									       "link_short": "https:\/\/evt.to\/iaaehuuw",
									       "link_long": "https:\/\/www.addevent.com\/event\/xh5112744",
									       "date_create": 1619341200,
									       "date_modified": 1619341200 
									   }
									}
									
Parameter
Description
token
Required

Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
event_id
Required

Id of the event to save.
title
Required

Title of the event. Single line string.
description
Description of the event. Use \n to separate lines. The field accepts plain text.
location
Location of the event, e.g. "1600 Amphitheatre Pkwy, Mountain View, CA 94043".
organizer
Event organizer, e.g. "Thomas Scott".

If you fill out organizer you must also include the organizer_email field.

If you include an organizer and an organizer_email, the event is considered to be a "meeting" by calendar clients like Outlook. If you don't include the fields, the event is considered to be an "appointment".
organizer_email
Event organizer e-mail, e.g. "thomas@example.com".

If you fill out organizer_email you must also include the organizer field.

If you include an organizer and an organizer_email, the event is considered to be a "meeting" by calendar clients like Outlook. If you don't include the fields, the event is considered to be an "appointment".
start_date
Required

Start date of the event. Accepts most date/time formats, e.g. 04/11/2021 03:00 PM (12-hour format) or 11-04-2021 15:00 (24-hour format).

Use numeric values to describe the date, e.g. "04/25/2021" and not textual, e.g. "April 25th, 2021".

Dates in the m/d/y or d-m-y formats are disambiguated by looking at the separator between the various components: if the separator is a slash (/), then the American m/d/y is assumed; whereas if the separator is a dash (-) or a dot (.), then the European d-m-y format is assumed. If, however, the year is given in a two digit format and the separator is a dash (-, the date string is parsed as y-m-d. To avoid potential ambiguity, it's best to use ISO 8601 (YYYY-MM-DD) dates

Date examples:
04/11/2021 03:00 PM or 11-04-2021 15:00 or 2021/04/11 03:00 PM or 2021-04-11 15:00
end_date
End date of the event. Accepts most date/time formats, e.g. 04/11/2021 05:00 PM (12-hour format) or 11-04-2021 17:00 (24-hour format).

Use numeric values to describe the date, e.g. "04/25/2021" and not textual, e.g. "April 25th, 2021".

Dates in the m/d/y or d-m-y formats are disambiguated by looking at the separator between the various components: if the separator is a slash (/), then the American m/d/y is assumed; whereas if the separator is a dash (-) or a dot (.), then the European d-m-y format is assumed. If, however, the year is given in a two digit format and the separator is a dash (-, the date string is parsed as y-m-d. To avoid potential ambiguity, it's best to use ISO 8601 (YYYY-MM-DD) dates

Date examples:
04/11/2021 05:00 PM or 11-04-2021 17:00 or 2021/04/11 05:00 PM or 2021-04-11 17:00

If end is not defined, the end date is automatically set to start date plus one hour.
timezone
Required

The events time zone, e.g. Europe/Paris or .

The timezone parameter converts the date/time to Zulu time / GMT / UTC. The timezone parameter defaults to "" if a timezone is not defined.

You can find a list of all time zones (Section: List of time zones) at the bottom of this page.

Explanation: The timezone parameter makes sure the date/time is correct no matter if you are in New York or Sydney.
all_day_event
All day event. Accepts true or false.
reminder
Event reminder. Trigger an event reminder e.g. "15" minutes before the event starts.
Accepted input: Number

Example: Reminder "15" minutes before event starts = 15 or
one day before event starts : 60 minutes x 24 hours = 1440.

Event reminders are currently supported by:
- Apple Calendar
- Outlook
rrule
Recurring rule, e.g. FREQ=WEEKLY;UNTIL=20211110T080000Z;BYDAY=WE,TH,FR Make the event repeat for a number of times.

Generate Recurring Rulebuild

Recurring rules are advanced and needs to be tested before you publish it. Please notice: The start date/time must match the recurrence rule in order to work in strict calendar systems like Outlook and Apple Calendar.

Recurring rules are currently supported by:
- Apple Calendar
- Google Calendar (using "Direct" and Google Events API)
- Office 365 (using the Microsoft Events API)
- Outlook
- Outlook.com (using Microsoft Events API)
template_id
ID of a "Custom Event Page" template, e.g. "a20418bkd038dkO". Uses the "AddEvent default" template if template_id is not defined. In order to create/access custom templates please go to the Custom Templates for events page.
custom_data
Allows you to save a JSON string containing keys and values which can be used with a custom event templates.

E.g. {"name":"Michael","bannerimage":"https://example.org/.../banner1.jpg"}

The system will collect the keys in the JSON string and make the keys/values available in the template markup.

E.g. use {{name}} or {{bannerimage}} to output the variables in your custom template.

Requires valid JSON. Max length of JSON string is 500 characters.
color
Color of the event as pre-defined in the calendar settings. Accepts 1 to 20.

Delete an event in a calendar

Deletes an event in a calendar. Returns a deletion status.

label
$ 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=API-TOKEN&event_id=159051
										

Returns

{
									   "meta": {
									       "code": "200"
									   },
									   "event": {
									       "id": "159051",
									       "status": "deleted"
									   }
									}
									
Parameter
Description
token
Required

Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
event_id
Required

Id of the event to delete.

List calendar subscribers

Returns a list of calendar subscribers. The subscribers are sorted by recently created.

label
$ 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=API-TOKEN&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=API-TOKEN&calendar_id=14793391331949&page=2"
									   }
									}
									
Parameter
Description
token
Required

Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
calendar_id
Required

Id of the calendar.

Sorting

Parameter
Description
page
If the list of subscribers contain more than 20 records the results are paginated. Use the page parameter to go through the next page of results.

Example:

$ curl https://www.addevent.com/api/v1/me/calendars/subscribers/list/?token=API-TOKEN&calendar_id=14793391331949&page=2
status
Use the status parameter to list only subscribers who are "active", "inactive", "blocked", or "all". If the status parameter isn't available, "all" is used.

Subscribers are "active" if their calendar vendor/app has made a request to the subscribed calendar feed within the past 30 days.

Example:

$ curl https://www.addevent.com/api/v1/me/calendars/subscribers/list/?token=API-TOKEN&calendar_id=14793391331949&page=2&status=inactive
order
List subscribers in a specific order.
Accepts: "asc" or "desc". Default is "desc".

Example:

$ curl https://www.addevent.com/api/v1/me/calendars/subscribers/list/?token=API-TOKEN&calendar_id=14793391331949&order=desc

View a subscriber

Returns details about a subscriber.

label
$ 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=API-TOKEN&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 2021 21:49pm (UTC)",
									         "lastsyncdate": "Oct 9th 2021 05:04am (UTC)"
									      }
									   }
									}					
									

Delete a subscriber

Delete a calendar subscriber. Returns a deletion status.

label
$ 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=API-TOKEN&calendar_id=14793391331949&user_id=wl150897869af
										

Returns

{
									   "meta": {
									       "code": "200"
									   },
									   "calendar": {
									       "subscriber": {
									           "userid": "rm1392020946xb",
									           "status": "deleted"
									       }
									   }
									}
									
Parameter
Description
token
Required

Account token. The account token is available in the Account section and is incorporated in all code examples on this page.
calendar_id
Required

Id of the calendar.
user_id
Required

Id of the subscriber.

List of time zones

Lists of all available time zones.

label
$ 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"
									   },
									   {
									       etc.
									   }]
									}
									

We've launched
a new service!

AppointmentThing is a simple yet powerful scheduling tool that makes it easy for your clients to schedule appointments with you, saving time for everyone. 😃