Events (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.

List events

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

$ curl https://www.addevent.com/api/v1/oe/events/list/?token=token
									
$ curl https://www.addevent.com/api/v1/oe/events/list/?token=API-TOKEN										

Returns

{
									   "meta": {
									       "code": "200"
									   },
									   "calendar": {
									       "events_count": 33
									   },
									   "events": [{
									       "id": "125163",
									       "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": "08\/21\/2018",
									       "date_start_time": "09:00:00",
									       "date_start_ampm": "AM",
									       "date_start_unix": 1534842000,
									       "date_end": "08\/21\/2018",
									       "date_end_time": "11:00:00",
									       "date_end_ampm": "AM",
									       "date_end_unix": 1534849200,
									       "all_day_event": "false",
									       "date_format": "MM\/DD\/YYYY",
									       "timezone": "America\/Los_Angeles",
									       "reminder": "60",
									       "date_create": 1534842000,
									       "date_modified": 1534842000,
									       "updated_times": "0",
									       "rsvp_require": "false",
									       "rsvp_template_id": ""
									   }, {
									       "id": "125162",
									       "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": "08\/14\/2018",
									       "date_start_time": "09:00:00",
									       "date_start_ampm": "AM",
									       "date_start_unix": 1534237200,
									       "date_end": "08\/14\/2018",
									       "date_end_time": "11:00:00",
									       "date_end_ampm": "AM",
									       "date_end_unix": 1534244400,
									       "all_day_event": "false",
									       "date_format": "MM\/DD\/YYYY",
									       "timezone": "America\/Los_Angeles",
									       "reminder": "60",
									       "date_create": 1534237200,
									       "date_modified": 1534237200,
									       "updated_times": "0",
									       "rsvp_require": "true",
									       "rsvp_template_id": "p39osKtoqR"
									   }],
									   "paging": {
									       "previous": "",
									       "next": "https:\/\/www.addevent.com\/api\/v1\/oe\/events\/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 an event

Creates an event. Returns the event created.

$ curl https://www.addevent.com/api/v1/oe/events/create/?token=token&title=title&eventname=eventname&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&rsvp_require=rsvp_require&rsvp_template_id=rsvp_template_id
									
$ curl https://www.addevent.com/api/v1/oe/events/create/?token=API-TOKEN&title=Title+of+the+event&eventname=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=10%2F04%2F2018+09%3A00&end_date=10%2F04%2F201811%3A00&all_day_event=false&rsvp_require=true&rsvp_template_id=p39osKtoqR
										

Returns

{
									   "meta": {
									       "code": "200"
									   },
									   "event": {
									       "id": 324058,
									       "uniquekey": "GV160458",
									       "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": "10\/04\/2018",
									       "date_start_time": "09:00:00",
									       "date_start_ampm": ""AM"",
									       "date_end": "10\/04\/2018",
									       "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",
									       "updated_times": "0",
									       "date_create": 1538643600,
									       "date_modified": 1538643600,
									       "rsvp_require": "true",
									       "rsvp_template_id": "p39osKtoqR"
									   }
									}
									
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.
eventname
Name of the event. Use for internal purpose only.
description
Description of the event. Use \n to separate lines.

The field accepts plain text or simplified HTML. Simplified HTML is supported by calendar clients like Outlook and Apple Calendar. If the calendar client does accept HTML, the content of the field is automatically converted into readable text.

Keep the description short and to the point. Link to a website for further details if the event description is long. Maximum 500 characters recommended.

Reason: Most modern browsers allow an unlimited number of characters to be transfered by the browser. Internet Explorer / Edge only allows ~2000 characters. A 500 characters maximum is recommended to make sure your event is cross browser compatible.
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".
timezone
Required

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

The timezone parameter converts the date/time to Zulu time / GMT / UTC. The timezone parameter defaults to "America/Los_Angeles" 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.
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
start_date
Required

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

Use numeric values to describe the date, e.g. "10/04/2018" and not textual, e.g. "October 4th, 2018".

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:
09/20/2018 03:00 PM or 20-09-2018 15:00 or 2018/09/20 03:00 PM or 2018-09-20 15:00
end_date
End date of the event. Accepts most date/time formats, e.g. 09/20/2018 05:00 PM (12-hour format) or 20-09-2018 17:00 (24-hour format).

Use numeric values to describe the date, e.g. "10/04/2018" and not textual, e.g. "October 4th, 2018".

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:
09/20/2018 05:00 PM or 20-09-2018 17:00 or 2018/09/20 05:00 PM or 2017-03-17 17:00

If end is not defined, the end date is automatically set to start date plus one hour.
all_day_event
All day event. Accepts true or false.
rsvp_require
Whether the event requires RSVP or not. Optional. Accepts true or false.
rsvp_template_id
ID of the RSVP template to use. Optional. If no template ID is specified the event uses the "Standard RSVP template". RSVP templates can be created manually in the "Events" section.

Save an event

Save an event. Returns the event saved.

$ curl https://www.addevent.com/api/v1/oe/events/save/?token=token&event_id=event_id&title=title&eventname=eventname&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&rsvp_require=rsvp_require&rsvp_template_id=rsvp_template_id
									
$ curl https://www.addevent.com/api/v1/oe/events/save/?token=API-TOKEN&event_id=159051&title=Title+of+the+event&eventname=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=10%2F04%2F2018+09%3A00&end_date=10%2F04%2F201811%3A00&all_day_event=false&rsvp_require=true&rsvp_template_id=p39osKtoqR
										

Returns

{
									   "meta": {
									       "code": "200"
									    },
									   "event": {
									       "id": 159051,
									       "uniquekey": "GV160458",
									       "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": "10\/04\/2018",
									       "date_start_time": "09:00:00",
									       "date_start_ampm": "AM",
									       "date_end": "10\/04\/2018",
									       "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",
									       "updated_times": "1",
									       "date_create": 1538643600,
									       "date_modified": 1538643600,
									       "rsvp_require": "true",
									       "rsvp_template_id": "p39osKtoqR"
									    }
									}
									
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.
title
Required

Title of the event. Single line string.
eventname
Name of the event. Use for internal purpose only.
description
Description of the event. Use \n to separate lines.

The field accepts plain text or simplified HTML. Simplified HTML is supported by calendar clients like Outlook and Apple Calendar. If the calendar client does accept HTML, the content of the field is automatically converted into readable text.

Keep the description short and to the point. Link to a website for further details if the event description is long. Maximum 500 characters recommended.

Reason: Most modern browsers allow an unlimited number of characters to be transfered by the browser. Internet Explorer / Edge only allows ~2000 characters. A 500 characters maximum is recommended to make sure your event is cross browser compatible.
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".
timezone
Required

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

The timezone parameter converts the date/time to Zulu time / GMT / UTC. The timezone parameter defaults to "America/Los_Angeles" 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.
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
start_date
Required

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

Use numeric values to describe the date, e.g. "10/04/2018" and not textual, e.g. "October 4th, 2018".

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:
09/20/2018 03:00 PM or 20-09-2018 15:00 or 2018/09/20 03:00 PM or 2018-09-20 15:00
end_date
End date of the event. Accepts most date/time formats, e.g. 09/20/2018 05:00 PM (12-hour format) or 20-09-2018 17:00 (24-hour format).

Use numeric values to describe the date, e.g. "10/04/2018" and not textual, e.g. "October 4th, 2018".

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:
09/20/2018 05:00 PM or 20-09-2018 17:00 or 2018/09/20 05:00 PM or 2017-03-17 17:00

If end is not defined, the end date is automatically set to start date plus one hour.
all_day_event
All day event. Accepts true or false.
rsvp_require
Whether the event requires RSVP or not. Optional. Accepts true or false.
rsvp_template_id
ID of the RSVP template to use. Optional. If no template ID is specified the event uses the "Standard RSVP template". RSVP templates can be created manually in the "Events" section.

Delete an event

Deletes an event. Returns a deletion status.

$ curl https://www.addevent.com/api/v1/oe/events/delete/?token=token&event_id=event_id
									
$ curl https://www.addevent.com/api/v1/oe/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.

List of time zones

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