Preview list rules
/api/lists/previewWho a rule tree lets through right now, and the first page of them. Figures counted from presence reports are close rather than exact; fromPolledData says when that is so, and closeCalls counts the people near a threshold. A rule reaching further back than the facts Modbot still keeps comes back in unanswerable instead of an answer.
Needs the ViewMembers and ViewProfile and ManageLists permissions.
An API key, made on Settings, API keys. Every key starts with mbk_.
In: header
Query Parameters
int32Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/api/lists/preview" \ -H "Content-Type: application/json" \ -d '{ "rules": null }'{ "count": 0, "considered": 0, "closeCalls": 0, "fromPolledData": true, "unanswerable": null, "stopped": true, "countedAt": "2019-08-24T14:15:22Z", "people": [ { "key": "string", "vrChatUserId": null, "discordUserId": null, "name": null, "inGroup": true, "inDiscord": true, "linked": true, "fromPolledData": true, "closeCall": true } ], "page": 0, "pageSize": 0}Get list builder GET
The rule kinds and the roles a list's rules can name. Needs the `ManageLists` permission.
List the people in a list GET
Who is in a saved list right now, by name, a page at a time. Worked out again on every request: a list is its rules, not a copy of who matched them once. Needs the `ViewMembers` and `ViewProfile` permissions.