Menu
more_horiz
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=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",
"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": "07\/21\/2022",
"date_start_time": "09:00:00",
"date_start_ampm": "AM",
"date_start_unix": 1658394000,
"date_end": "07\/21\/2022",
"date_end_time": "11:00:00",
"date_end_ampm": "AM",
"date_end_unix": 1658401200,
"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",
"custom_data": "",
"link_short": "https:\/\/evt.to\/iaaehuuw",
"link_long": "https:\/\/www.addevent.com\/event\/xh5112744",
"date_create": 1658394000,
"date_modified": 1658394000
}, {
"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": "07\/14\/2022",
"date_start_time": "09:00:00",
"date_start_ampm": "AM",
"date_start_unix": 1657789200,
"date_end": "07\/14\/2022",
"date_end_time": "11:00:00",
"date_end_ampm": "AM",
"date_end_unix": 1657796400,
"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",
"custom_data": "",
"link_short": "https:\/\/evt.to\/iaaehuuw",
"link_long": "https:\/\/www.addevent.com\/event\/xh5112744",
"date_create": 1658394000,
"date_modified": 1658394000 }],
"paging": {
"previous": "",
"next": "https:\/\/www.addevent.com\/api\/v1\/oe\/events\/list\/?token=API-TOKEN&page=2"
}
}
$ 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=API-TOKEN&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=08%2F24%2F2022+09%3A00&end_date=08%2F24%2F202211%3A00&all_day_event=false&rsvp_require=true&rsvp_template_id=p39osKtoqR&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": 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": "08\/24\/2022",
"date_start_time": "09:00:00",
"date_start_ampm": ""AM"",
"date_end": "08\/24\/2022",
"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",
"updated_times": "0",
"rsvp_require": "true",
"rsvp_template_id": "p39osKtoqR",
"custom_data": ""{\"name\":\"Michael\",\"bannerimage\":\"https:\/\/example.org\/...\/banner1.jpg\"}"",
"link_short": "https:\/\/evt.to\/iaaehuuw",
"link_long": "https:\/\/www.addevent.com\/event\/xh5112744",
"date_create": 1661331600,
"date_modified": 1661331600 }
}
$ 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=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=08%2F24%2F2022+09%3A00&end_date=08%2F24%2F202211%3A00&all_day_event=false&rsvp_require=true&rsvp_template_id=p39osKtoqR&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",
"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": "08\/24\/2022",
"date_start_time": "09:00:00",
"date_start_ampm": "AM",
"date_end": "08\/24\/2022",
"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",
"updated_times": "1",
"rsvp_require": "true",
"rsvp_template_id": "p39osKtoqR",
"custom_data": ""{\"name\":\"Michael\",\"bannerimage\":\"https:\/\/example.org\/...\/banner1.jpg\"}"",
"link_short": "https:\/\/evt.to\/iaaehuuw",
"link_long": "https:\/\/www.addevent.com\/event\/xh5112744",
"date_create": 1661331600,
"date_modified": 1661331600 }
}
$ 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"
}
}
$ 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=API-TOKEN&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",
"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=API-TOKEN&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=API-TOKEN&event_id=159051&page=2
$ curl https://www.addevent.com/api/v1/oe/rsvps/list/?token=API-TOKEN&event_id=159051&attending=1
$ 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=API-TOKEN&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)"
}
}
}
$ 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=API-TOKEN&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 2022 14:47pm (UTC)",
"modifydate": "Jul 19th 2022 15:32pm (UTC)"
}
}
$ 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=API-TOKEN&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 2022 14:47pm (UTC)",
"modifydate": "Jul 19th 2022 15:32pm (UTC)"
}
}
$ 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 need your help. 😎 Please tell us a little about yourself and your company to help
us provide a better customer experience.
It only takes about 30 seconds to complete. Thank you! 🙏
What's the name of your company/organization?
Where is your company?
Our robot has made a guesstimate on the basis of your IP address. Please correct it if it's wrong.
How many employees does your company have?
In which industry does your company operate?
What is your role in the company?
How do you expect to use our services? What would
you like to accomplish?
Thank you so much!
Please select an option
TIP! Press ENTER to continue
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. 😃