Modbot Docs
APIAPI referenceSettings

List who holds an automatic role

GET/api/settings/automatic-roles/{id}/holders

Modbot accounts that hold the rule's role in Modbot's copy of the group and server members, and accounts the rule applies to that do not hold it. A rule that gives both a VRChat and a Discord role lists each account once per role. given says whether Modbot has an open grant for the role (byModbot), not (byHand), or the account does not hold it (notHeld). ruleMet says whether every condition is met, and conditions lists each condition the rule switches on with whether it is met and the numbers behind it.

Needs the ManageSettings permission.

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/api/settings/automatic-roles/497f6eca-6276-4993-bfeb-53cbbbba6f08/holders"
{  "holders": [    {      "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",      "username": "string",      "platform": "string",      "roleName": "string",      "given": "ByModbot",      "ruleMet": true,      "conditions": [        {          "label": "string",          "met": true,          "reason": null,          "count": null,          "max": null,          "days": null        }      ]    }  ]}

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.