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 events in a calendar. The events are sorted by recently created.
$ curl https://www.addevent.com/api/v1/oe/events/list/?token=token&calendar_id=calendar_id
$ curl https://www.addevent.com/api/v1/oe/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",
"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": "",
"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": "",
"updated_times": "0",
"rsvp_require": "true",
"rsvp_template_id": "",
"rsvp_seat_limited": "true",
"rsvp_seat_limit": "50",
"rsvp_seats_left": "45",
"rsvp_inactive": "false",
"rsvp_notify": "email@example.org",
"rsvp_count": "8",
"rsvp_attn_going": "5",
"rsvp_attn_maybe": "2",
"rsvp_attn_cantgo": "1",
"color": "2",
"transp": "busy",
"custom_data": "",
"link_short": "https:\/\/evt.to\/iaaehuuw",
"link_long": "https:\/\/www.addevent.com\/event\/xh5112744",
"date_create": 1732179600,
"date_modified": 1732179600
}, {
"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": "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": "",
"updated_times": "0",
"rsvp_require": "true",
"rsvp_template_id": "",
"rsvp_seat_limited": "true",
"rsvp_seat_limit": "50",
"rsvp_seats_left": "45",
"rsvp_inactive": "false",
"rsvp_notify": "email@example.org",
"rsvp_count": "8",
"rsvp_attn_going": "5",
"rsvp_attn_maybe": "2",
"rsvp_attn_cantgo": "1",
"color": "2",
"transp": "busy",
"custom_data": "",
"link_short": "https:\/\/evt.to\/iaaehuuw",
"link_long": "https:\/\/www.addevent.com\/event\/xh5112744",
"date_create": 1732179600,
"date_modified": 1732179600 }],
"paging": {
"previous": "",
"next": "https:\/\/www.addevent.com\/api\/v1\/oe\/events\/list\/?token=USER-TOKEN-ID&page=2"
}
}
Creates an event in a calendar. Returns the event created.
$ curl https://www.addevent.com/api/v1/oe/events/create/?token=token&calendar_id=calendar_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&custom_data=custom_data
$ curl https://www.addevent.com/api/v1/oe/events/create/?token=USER-TOKEN-ID&calendar_id=1473327868906&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=12%2F19%2F2024+09%3A00&end_date=12%2F19%2F202411%3A00&all_day_event=false&rsvp_require=true&rsvp_template_id=p39osKtoqR&custom_data=
Returns
{
"meta": {
"code": "200"
},
"event": {
"id": 324058,
"calendar": "1473327868906",
"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": "12\/19\/2024",
"date_start_time": "09:00:00",
"date_start_ampm": "AM",
"date_end": "12\/19\/2024",
"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",
"updated_times": "0",
"rsvp_require": "true",
"rsvp_template_id": "p39osKtoqR",
"custom_data": "",
"link_short": "https:\/\/evt.to\/iaaehuuw",
"link_long": "https:\/\/www.addevent.com\/event\/xh5112744",
"date_create": 1734598800,
"date_modified": 1734598800 }
}
Save an event in a calendar. 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&custom_data=custom_data
$ curl https://www.addevent.com/api/v1/oe/events/save/?token=USER-TOKEN-ID&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=12%2F19%2F2024+09%3A00&end_date=12%2F19%2F202411%3A00&all_day_event=false&rsvp_require=true&rsvp_template_id=p39osKtoqR&custom_data=
Returns
{
"meta": {
"code": "200"
},
"event": {
"id": 159051,
"calendar": "1473327868906",
"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": "12\/19\/2024",
"date_start_time": "09:00:00",
"date_start_ampm": "AM",
"date_end": "12\/19\/2024",
"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",
"updated_times": "1",
"rsvp_require": "true",
"rsvp_template_id": "p39osKtoqR",
"custom_data": "",
"link_short": "https:\/\/evt.to\/iaaehuuw",
"link_long": "https:\/\/www.addevent.com\/event\/xh5112744",
"date_create": 1734598800,
"date_modified": 1734598800 }
}
Deletes an event in a calendar. 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=USER-TOKEN-ID&event_id=159051
Returns
{
"meta": {
"code": "200"
},
"event": {
"id": "159051",
"status": "deleted"
}
}
View details about an event in a calendar. Returns the event details.
$ curl https://www.addevent.com/api/v1/oe/events/event/?token=token&event_id=event_id
$ curl https://www.addevent.com/api/v1/oe/events/event/?token=USER-TOKEN-ID&event_id=159051
Returns
{
"meta": {
"code": "200"
},
"event": {
"id": "997204",
"calendar": "1473327868906",
"unique": "pM997204",
"title": "Title of the event (example with RSVP)",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque euismod scelerisque ex, bibendum semper nulla consectetur nec. Ut rhoncus imperdiet urna, in mollis tortor mollis eu. Ut euismod rutrum gravida. Donec molestie aliquet nisl, vitae ullamcorper magna feugiat vel. Etiam eu blandit risus. Morbi et dolor id felis maximus pellentesque.",
"location": "18 Bartol Street, San Francisco, CA 94133, USA",
"organizer": "AddEvent.com",
"organizer_email": "events@addevent.com",
"date_start": "11\/20\/2018",
"date_start_time": "09:00:00",
"date_start_ampm": "AM",
"date_start_unix": 1542700800,
"date_end": "11\/20\/2018",
"date_end_time": "11:00:00",
"date_end_ampm": "AM",
"date_end_unix": 1542708000,
"all_day_event": "false",
"date_format": "MM\/DD\/YYYY",
"timezone": "America\/Los_Angeles",
"reminder": "0",
"rrule": "",
"template_id": "a20418bkd038dkO",
"color": "2",
"transp": "busy",
"updated_times": "7",
"rsvp_require": "true",
"rsvp_template_id": "17zJBMGvbswn",
"rsvp_seat_limited": "true",
"rsvp_seat_limit": "50",
"rsvp_seats_left": "45",
"rsvp_inactive": "false",
"rsvp_notify": "email@example.org",
"rsvp_count": "8",
"rsvp_attn_going": "5",
"rsvp_attn_maybe": "2",
"rsvp_attn_cantgo": "1",
"custom_data": "",
"date_create": 1522771966,
"date_modified": 1538410290,
"link_short": "https:\/\/evt.to\/iaaehuuw",
"link_long": "https:\/\/www.addevent.com\/event\/xh5112744"
}
}
Returns a list of attendees who have RSVP'ed for an event in a calendar. The attendees are sorted by recently created.
$ curl https://www.addevent.com/api/v1/oe/rsvps/list/?token=token&event_id=event_id
$ curl https://www.addevent.com/api/v1/oe/rsvps/list/?token=USER-TOKEN-ID&event_id=159051
Returns
{
"meta": {
"code": "200"
},
"summary": {
"rsvp_count": 2,
"going": "1",
"maybe": "1",
"cant_go": "0"
},
"rsvps": {
"header": {
"attending": "Attending",
"name": "Name",
"email": "Email",
"ip": "IP",
"city": "City",
"region": "Region",
"country": "Country",
"location": "Location",
"postal": "Postal",
"userid": "System Id",
"createdate": "Create date",
"modifydate": "Last save date"
},
"attendees": [{
"attending": "Going",
"attending_code": "1",
"name": "Sam Smith",
"email": "sam@example.org",
"ip": "",
"city": "Rybnik",
"region": "Silesia",
"country": "PL",
"location": "",
"postal": "44-203",
"userid": "VtgTLlUv17823",
"createdate": "Oct 2nd 2018 09:26am (UTC)",
"modifydate": "Oct 2nd 2018 09:26am (UTC)"
}, {
"attending": "Maybe",
"attending_code": "2",
"name": "Scott Flynn",
"email": "scott@example.org",
"ip": "24.xxx.111.44",
"city": "Laval",
"region": "Quebec",
"country": "CA",
"location": "45.5793,-73.7367",
"postal": "H7S",
"userid": "eILFqBUg17579",
"createdate": "Sep 28th 2018 18:30pm (UTC)",
"modifydate": "Oct 1st 2018 18:11pm (UTC)"
}]
},
"paging": {
"previous": "",
"next": ""
}
}
Sorting
$ curl https://www.addevent.com/api/v1/oe/rsvps/list/?token=USER-TOKEN-ID&event_id=159051&page=2
$ curl https://www.addevent.com/api/v1/oe/rsvps/list/?token=USER-TOKEN-ID&event_id=159051&attending=1
Returns details about an RSVP attendee.
$ curl https://www.addevent.com/api/v1/oe/rsvps/attendee/?token=token&event_id=event_id&user_id=user_id
$ curl https://www.addevent.com/api/v1/oe/rsvps/attendee/?token=USER-TOKEN-ID&event_id=159051&user_id=kimTo3029
Returns
{
"meta": {
"code": "200"
},
"rsvps": {
"header": {
"attending": "Attending",
"name": "Name",
"email": "Email",
"ip": "IP",
"city": "City",
"region": "Region",
"country": "Country",
"location": "Location",
"postal": "Postal",
"userid": "System Id",
"createdate": "Create date",
"modifydate": "Last save date"
},
"attendees": {
"attending": "Going",
"attending_code": "1",
"name": "Sam Smith",
"email": "sam@example.org",
"ip": "",
"city": "Rybnik",
"region": "Silesia",
"country": "PL",
"location": "",
"postal": "44-203",
"userid": "VtgTLlUv17823",
"createdate": "Oct 2nd 2018 09:26am (UTC)",
"modifydate": "Oct 2nd 2018 09:26am (UTC)"
}
}
}
Creates an attendee for an RSVP event. Returns the created attendee.
$ curl https://www.addevent.com/api/v1/oe/rsvps/attendee/create/?token=token&event_id=event_id&name=name&email=email&attending=value
$ curl https://www.addevent.com/api/v1/oe/rsvps/attendee/create/?token=USER-TOKEN-ID&event_id=159051&name=Justin&email=justin@case.co&attending=1
Returns
{
"meta": {
"code": "200"
},
"attendee": {
"attending": "going",
"attending_code": "1",
"userid": "qtJCsFbY406609",
"name": "Justin Case",
"email": "justin@case.co",
"variable": "value",
"fld-dbbar": "45938475",
"ip": "",
"city": "",
"region": "",
"country": "",
"location": "",
"postal": "",
"createdate": "Jul 19th 2024 14:47pm (UTC)",
"modifydate": "Jul 19th 2024 15:32pm (UTC)"
}
}
Save an attendee for an RSVP event. Returns the saved attendee.
$ curl https://www.addevent.com/api/v1/oe/rsvps/attendee/save/?token=token&event_id=event_id&name=name&email=email&attending=value&userid=userid
$ curl https://www.addevent.com/api/v1/oe/rsvps/attendee/save/?token=USER-TOKEN-ID&event_id=159051&name=Justin&email=justin@case.co&attending=2&userid=qtJCsFcY406609
Returns
{
"meta": {
"code": "200"
},
"attendee": {
"attending": "maybe",
"attending_code": "2",
"userid": "qtJCsFbY406609",
"name": "Justin Case",
"email": "justin@case.co",
"variable": "value",
"fld-dbbar": "45938475",
"ip": "",
"city": "",
"region": "",
"country": "",
"location": "",
"postal": "",
"createdate": "Jul 19th 2024 14:47pm (UTC)",
"modifydate": "Jul 19th 2024 15:32pm (UTC)"
}
}
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"
}]
}