VRChatBackendDocs/Apis/CalendarApi.md

CalendarApi

All URIs are relative to https://api.vrchat.cloud/api/1

Method	HTTP request	Description
createGroupCalendarEvent	POST /calendar/{groupId}/event	Create a calendar event
deleteGroupCalendarEvent	DELETE /calendar/{groupId}/{calendarId}	Delete a calendar event
discoverCalendarEvents	GET /calendar/discover	Discover calendar events
followGroupCalendarEvent	POST /calendar/{groupId}/{calendarId}/follow	Follow a calendar event
getCalendarEvents	GET /calendar	List calendar events
getFeaturedCalendarEvents	GET /calendar/featured	List featured calendar events
getFollowedCalendarEvents	GET /calendar/following	List followed calendar events
getGroupCalendarEvent	GET /calendar/{groupId}/{calendarId}	Get a calendar event
getGroupCalendarEventICS	GET /calendar/{groupId}/{calendarId}.ics	Download calendar event as ICS
getGroupCalendarEvents	GET /calendar/{groupId}	List a group's calendar events
getGroupNextCalendarEvent	GET /calendar/{groupId}/next	Get next calendar event
searchCalendarEvents	GET /calendar/search	Search for calendar events
updateGroupCalendarEvent	PUT /calendar/{groupId}/{calendarId}/event	Update a calendar event

createGroupCalendarEvent

CalendarEvent createGroupCalendarEvent(groupId, CreateCalendarEventRequest)

Create a calendar event

Creates an event for a group on the calendar

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.	[default to null]
CreateCalendarEventRequest	CreateCalendarEventRequest

Return type

CalendarEvent

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json

deleteGroupCalendarEvent

Success deleteGroupCalendarEvent(groupId, calendarId)

Delete a calendar event

Delete a group calendar event

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.	[default to null]
calendarId	String	Must be a valid calendar ID.	[default to null]

Return type

Success

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

discoverCalendarEvents

CalendarEventDiscovery discoverCalendarEvents(scope, categories, tags, featuredResults, nonFeaturedResults, personalizedResults, minimumInterestCount, minimumRemainingMinutes, upcomingOffsetMinutes, n, nextCursor)

Discover calendar events

Get a list of calendar events Initially, call without a `nextCursor` parameter For every successive call, use the `nextCursor` property returned in the previous call & the `number` of entries desired for this call The `nextCursor` internally keeps track of the `offset` of the results, the initial request parameters, and accounts for discrepancies that might arise from time elapsed between calls

Parameters

Name	Type	Description	Notes
scope	String	Scope for calendar event discovery.	[optional] [default to upcoming] [enum: all, live, upcoming]
categories	String	Filter for calendar event discovery.	[optional] [default to null]
tags	String	Filter for calendar event discovery.	[optional] [default to null]
featuredResults	String	Filter for calendar event discovery.	[optional] [default to include] [enum: exclude, include, skip]
nonFeaturedResults	String	Filter for calendar event discovery.	[optional] [default to include] [enum: exclude, include, skip]
personalizedResults	String	Filter for calendar event discovery.	[optional] [default to include] [enum: exclude, include, skip]
minimumInterestCount	Integer	Filter for calendar event discovery.	[optional] [default to null]
minimumRemainingMinutes	Integer	Filter for calendar event discovery.	[optional] [default to null]
upcomingOffsetMinutes	Integer	Filter for calendar event discovery.	[optional] [default to null]
n	Integer	The number of objects to return.	[optional] [default to 60]
nextCursor	String	Cursor returned from previous calendar discovery queries (see nextCursor property of the schema CalendarEventDiscovery).	[optional] [default to null]

Return type

CalendarEventDiscovery

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

followGroupCalendarEvent

CalendarEvent followGroupCalendarEvent(groupId, calendarId, FollowCalendarEventRequest)

Follow a calendar event

Follow or unfollow an event on a group's calendar

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.	[default to null]
calendarId	String	Must be a valid calendar ID.	[default to null]
FollowCalendarEventRequest	FollowCalendarEventRequest

Return type

CalendarEvent

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json

getCalendarEvents

PaginatedCalendarEventList getCalendarEvents(date, n, offset)

List calendar events

Get a list of a user's calendar events for the month in ?date

Parameters

Name	Type	Description	Notes
date	Date	The month to search in.	[optional] [default to null]
n	Integer	The number of objects to return.	[optional] [default to 60]
offset	Integer	A zero-based offset from the default object sorting from where search results start.	[optional] [default to null]

Return type

PaginatedCalendarEventList

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getFeaturedCalendarEvents

PaginatedCalendarEventList getFeaturedCalendarEvents(date, n, offset)

List featured calendar events

Get a list of a featured calendar events for the month in ?date

Parameters

Name	Type	Description	Notes
date	Date	The month to search in.	[optional] [default to null]
n	Integer	The number of objects to return.	[optional] [default to 60]
offset	Integer	A zero-based offset from the default object sorting from where search results start.	[optional] [default to null]

Return type

PaginatedCalendarEventList

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getFollowedCalendarEvents

PaginatedCalendarEventList getFollowedCalendarEvents(date, n, offset)

List followed calendar events

Get a list of a followed calendar events for the month in ?date

Parameters

Name	Type	Description	Notes
date	Date	The month to search in.	[optional] [default to null]
n	Integer	The number of objects to return.	[optional] [default to 60]
offset	Integer	A zero-based offset from the default object sorting from where search results start.	[optional] [default to null]

Return type

PaginatedCalendarEventList

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getGroupCalendarEvent

CalendarEvent getGroupCalendarEvent(groupId, calendarId)

Get a calendar event

Get a group calendar event

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.	[default to null]
calendarId	String	Must be a valid calendar ID.	[default to null]

Return type

CalendarEvent

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getGroupCalendarEventICS

File getGroupCalendarEventICS(groupId, calendarId)

Download calendar event as ICS

Returns the specified calendar in iCalendar (ICS) format.

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.	[default to null]
calendarId	String	Must be a valid calendar ID.	[default to null]

Return type

File

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: text/calendar, application/json

getGroupCalendarEvents

PaginatedCalendarEventList getGroupCalendarEvents(groupId, date, n, offset)

List a group's calendar events

Get a list of a group's calendar events

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.	[default to null]
date	Date	The month to search in.	[optional] [default to null]
n	Integer	The number of objects to return.	[optional] [default to 60]
offset	Integer	A zero-based offset from the default object sorting from where search results start.	[optional] [default to null]

Return type

PaginatedCalendarEventList

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getGroupNextCalendarEvent

CalendarEvent getGroupNextCalendarEvent(groupId)

Get next calendar event

Get the closest future calendar event scheduled for a group

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.	[default to null]

Return type

CalendarEvent

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

searchCalendarEvents

PaginatedCalendarEventList searchCalendarEvents(searchTerm, utcOffset, n, offset, isInternalVariant)

Search for calendar events

Get a list of calendar events by search terms

Parameters

Name	Type	Description	Notes
searchTerm	String	Search term for calendar events.	[default to null]
utcOffset	Integer	The offset from UTC in hours of the client or authenticated user.	[optional] [default to null]
n	Integer	The number of objects to return.	[optional] [default to 60]
offset	Integer	A zero-based offset from the default object sorting from where search results start.	[optional] [default to null]
isInternalVariant	Boolean	Not quite sure what this actually does (exists on the website but doesn't seem to be used)	[optional] [default to null]

Return type

PaginatedCalendarEventList

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

updateGroupCalendarEvent

CalendarEvent updateGroupCalendarEvent(groupId, calendarId, UpdateCalendarEventRequest)

Update a calendar event

Updates an event for a group on the calendar

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.	[default to null]
calendarId	String	Must be a valid calendar ID.	[default to null]
UpdateCalendarEventRequest	UpdateCalendarEventRequest

Return type

CalendarEvent

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json