Modbot Docs
APIAPI referenceWorld lists

List world lists

GET/api/world-lists

The Seen list first, then every world list by name, with its worlds, their players, and the events that pick from it. The Seen list holds every world Modbot has seen and cannot be changed; pass seenWorlds=false to get it without its worlds, which is all a picker needs.

Needs the ViewCalendar permission.

AuthorizationBearer <token>

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

In: header

Query Parameters

seenWorlds?boolean

Response Body

application/json

application/problem+json

application/problem+json

curl -X GET "https://example.com/api/world-lists"
{  "lists": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "worlds": [        {          "worldId": "string",          "name": null,          "thumbnailUrl": null,          "imageUrl": null,          "minPlayers": null,          "maxPlayers": null,          "platforms": null        }      ],      "usedBy": [        {          "eventId": "d6703cc8-9e79-415d-ac03-a4dc7f6ab43c",          "title": "string",          "state": "string"        }      ],      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "seen": true    }  ],  "canManage": 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.