Apollo API Documentation

Legacy events API calls


List all events

GET /calendars/events?#{search_query}

Returns a collection of events that are visible to the authenticated user. Use the search query to refine your search. Available parameters are:

  • “page”: if the results are many you can jump to the next page using the “page” parameter.
  • “from”: you can ignore events before a certain date.
  • “to”: you can ignore events after a certain date.
  • “calendar-ids”: a list of calendar ids in the form of a string (Ex.: '42633755,42600755,3648922').

Response

{
	"continued-at":"/calendars/events?page=2",
	"events":[
		{
			"id":"94832146",
			"subject":"An event",
			...
		},
		{
			"id":"83411557",
			"subject":"Another event",
			...
		},
		...
	]
}

List all recurrent events

GET /calendars/events/recurrent?#{search_query}

Returns a collection of recurrent events that are visible to the authenticated user. Use the search query to refine your search. Available parameters are:

  • “page”: if the results are many you can jump to the next page using the “page” parameter.
  • “from”: you can ignore events before a certain date.
  • “to”: you can ignore events after a certain date.
  • “calendar-ids”: a list of calendar ids in the form of a string (Ex.: '42633755,42600755,3648922').

Response

{
	"continued-at":"/calendars/events/recurrent?page=2",
	"events":[
		{
			"id":"94832146",
			"subject":"An event",
			...
		},
		{
			"id":"83411557",
			"subject":"Another event",
			...
		},
		...
	]
}

Get event

GET /events/#{id}

Returns a single event record identified by its integer ID.

Response

{
	"event":{
		"id":"94832146",
		"subject":"An event",
		...
	}
}

Create event

POST /calendars/#{calendar_id}/events

Creates a new event.

Request

{
	"event":{
		"subject":"Meet up",
		"location":"New York",
		"start":"2012-11-05 10:30:00",
		"end":"2012-11-05 13:30:00",
		"allday-flag":"0",
		"notes":"Important",
		"privacy-type":"public",
		"recur-type":"weekly",
		"recur-start":"2012-11-05",
		"recur-end":"2013-04-23",
		"recur-interval":"2",
		"recur-days-of-week":"monday,friday"
	}
}

Response

Returns HTTP status code 201 (“Created”) on success. The response contain the new event ID. On failure, a non-200 status code will be returned, possibly with error information in JSON format as the response's content.

{
	"event-id":"9056560"
}

Update event

PUT /events/#{id}

Updates an existing event.

Request

{
	"event":{
		"subject":"Updated event",
		"privacy-type":"private"
	}
}

Response

Returns HTTP status code 200 on success, or any other code (and possibly error information in JSON format) on error.


Destroy event

DELETE /events/#{id}

Destroys the given event.

Response

Returns HTTP status code 200 on success, or any other code (and possibly error information in JSON format) on error.