Modbot Docs
APIAPI referenceAnnouncements

List instance announcements

GET/api/announcements

The messages sent or scheduled to the group's instances that are still open, newest first, at most 200, each with how it went. Read from Modbot's own tables; nothing here calls VRChat.

Needs the ViewLiveInstances permission.

AuthorizationBearer <token>

An API key, made on Settings, API keys. Every key starts with mbk_.

In: header

Response Body

application/json

application/problem+json

application/problem+json

curl -X GET "https://example.com/api/announcements"
{  "announcements": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "instanceId": "64d2028c-ae87-4069-a624-66089d957ef9",      "title": "string",      "message": "string",      "state": "string",      "sendAt": "2019-08-24T14:15:22Z",      "timeZone": "string",      "sentAt": null,      "status": null,      "error": null,      "missingGroupPermission": null,      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "canSend": true}

Modbot is not endorsed by or affiliated with VRChat Inc. or Discord Inc. VRChat is a trademark of VRChat Inc. Discord is a trademark of Discord Inc. SteamVR is a trademark of Valve Corporation. Windows is a trademark of Microsoft Corporation. Docker is a trademark of Docker, Inc. PostgreSQL is a trademark of the PostgreSQL Community Association of Canada. Railway is a trademark of Railway Corp. Other names are trademarks of their respective owners; see Legal. Modbot and its logo are trademarks of the Modbot project. Open source under AGPL-3.0.