|
Parameter
|
Description
|
Type
|
Notes
|
|
key
|
A Spongecell API, READ, or WRITE key. Visibility to the event is based on the type of event (PUBLIC, FRIENDS, PRIVATE) and your relationship with the creator.
|
Key
|
Optional
|
|
username
|
email address or username of the calendar owner
|
String
|
Required
|
|
user id
|
user id (as obtained from user api method) of the calendar owner
|
String
|
Optional
|
|
start_time
|
Get all events that occur after start time
|
DateTime
|
Optional
|
|
end_time
|
Get all events that occur before end time
|
DateTime
|
Optional
|
|
max_results
|
Max number of events desired.
|
Integer
|
Optional
|
|
compute_recurrence
|
When set to true, returns each instance of a recurring event. If max results is not specified, tops out at 50. By default, the recurrence is returned once.
|
Boolean
|
Optional
|
|
start_index
|
When compute_recurrence is set to true, this is used as the pagination index. For example, by specifying 5 for start_index and 10 for max_results, you will return results 5 through 15 from the start date specified.
|
Integer
|
Optional
|
|
show_invites
|
Includes events where the user has been invited, but has not acceptted. Only applicable when compute_recurrence=true
|
String
|
Optional
|
|
show_busy
|
When set to true, displays private events as *BUSY*
|
String
|
Optional
|
|
format
|
Format of output. Supports standard xml (default) and json. Use format=json to specify output in JSON.
|
String
|
Optional
|
