Get calendar
/api/calendarEvery event, with its occurrences in the range, where it is published and how that went, and which places are set up: VRChat needs a managed group and a VRChat account, Discord a server id and a connected bot.
Needs the ViewCalendar permission.
An API key, made on Settings, API keys. Every key starts with mbk_.
In: header
Query Parameters
date-timedate-timeResponse Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/api/calendar"{ "events": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "title": "string", "description": "string", "startsAt": "2019-08-24T14:15:22Z", "endsAt": "2019-08-24T14:15:22Z", "startsAtLocal": "string", "endsAtLocal": "string", "timeZone": "string", "repeat": "string", "repeatDays": [ "string" ], "repeatUntil": null, "worldId": null, "worldName": null, "worldThumbnailUrl": null, "worldImageUrl": null, "worldPlatforms": null, "accessType": "string", "region": "string", "imageUrl": null, "vrChatImageId": null, "category": "string", "languages": [ "string" ], "platforms": [ "string" ], "tags": [ "string" ], "visibility": "string", "notifyMembers": true, "publishToVRChat": true, "publishToDiscord": true, "postToChannel": true, "channelId": null, "autoOpen": true, "openMinutesBefore": 0, "state": "string", "occurrenceStartsAt": null, "occurrenceEndsAt": null, "version": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "madeOnVRChat": true, "places": [ { "place": "string", "state": "string", "error": null, "errorAt": null, "updatedAt": "2019-08-24T14:15:22Z", "missingGroupPermission": null, "canTryAgain": false, "problems": null, "link": null } ], "opening": null, "occurrences": [ { "startsAt": "2019-08-24T14:15:22Z", "endsAt": "2019-08-24T14:15:22Z", "plannedStartsAt": "2019-08-24T14:15:22Z", "title": null, "description": null, "vrChatError": null, "googleError": null } ], "cancelledAt": null, "worldListId": null, "worldListName": null, "worldListEmpty": false, "cancelledDates": null, "inviteHostUserId": null, "inviteStaffUserIds": null, "inviteListId": null, "inviteListName": null, "announceFirstJoinInDiscord": false, "invites": null, "announceFirstJoinInVRChat": false, "mentionRoleId": null, "repeatEvery": 1, "repeatTimes": null, "featured": false, "coverPictureId": null, "publishToGoogle": false, "vrChatRoleIds": null, "twitchStreams": null, "vrChatTitle": null, "vrChatDescription": null, "discordTitle": null, "discordDescription": null, "googleTitle": null, "googleDescription": null, "categories": null, "publishToBluesky": false, "blueskyPostBeforeMinutes": 1440, "blueskyTitle": null, "blueskyDescription": null, "announceFirstJoinOnBluesky": false, "postColour": null, "blueskyPictures": null, "blueskyWhoCanReply": null, "blueskyQuotesOff": false, "blueskyLanguages": null, "blueskyVideo": null, "blueskyGif": null, "googleColour": null, "googleShowAs": "free" } ], "canManage": true, "categories": [ "string" ], "platforms": [ "string" ], "now": "2019-08-24T14:15:22Z", "canSeeResults": false, "ready": null, "pictureUploads": false, "vrChatPlus": null}Count flagged people in instances GET
How many flagged people are in the group's open instances right now, by the same rules and the same "who is present" as the Live page: the number beside Live in the sidebar. Counts only instances a moderator is watching, because nobody else knows who is in one. Read from Modbot's own tables; nothing here calls VRChat. Needs the `ViewLiveInstances` permission.
Read VRChat's calendar POST
Brings events made on VRChat, and changes and deletes made there, into Modbot's calendar for the months asked for. A month read in the last five minutes is not asked for again unless refresh is set. Can take several seconds: VRChat's calendar is read gently. Needs the `ViewCalendar` permission.