Modbot Docs
APIAPI referencePeople

List people

GET/api/people

Every VRChat account Modbot has ever seen: members, people who left, people it only ever saw in an instance or in the audit log. search matches the display name and the id, case-insensitively and literally. membership is member, not-member, left or all (the default); banned is true or false for the group's ban list as it stands, everBanned true or false for a ban at any time, lifted or not; profile is fetched or not-fetched. eighteenPlus is true or false for Modbot's 18+ mark. trustRank is a trust rank name and may be repeated: people holding any of them, and never anybody whose tags have not been read. platform is the platform they last used, matched case-insensitively against whatever VRChat sent, and may be repeated. linked=linked shows only people with a linked Discord account and linked=not-linked only people without. flagged is true or false for having ever been flagged by a moderation rule, dismissed or not. seenFrom and seenTo narrow the list to people Modbot last saw inside that stretch. role is a group role id and may be repeated: people holding any of them; notRole, also repeatable, leaves out people holding any of those; noRole=true keeps only people with no role. representing is true or false. joinedFrom and joinedTo narrow the list to people who joined the group inside that stretch, which is what an unusual-activity alert links to. instance is a Modbot instance id: only people a moderator's client saw in that instance, each row with a visit (first arrival, last leave, how many visits). hereAt and notHereAt, repeatable and only with instance, keep people who were there at that moment, or were not; every one must hold. Sorted by when Modbot last saw them, most recent first, unless sort=name, sort=known (longest known first) or sort=joined (newest joiner first). With instance, the default is sort=arrived (first to arrive first) and sort=left puts the first to leave first. Names and pictures come from the profile sync and are null for anybody it has not fetched yet. Each row carries the member list's fields too: roles, when they joined, whether they are representing the group, and their linked Discord account. roles lists the group's roles with how many current members hold each.

Needs See profiles. See members alone is enough for membership=member or membership=left, without flagged or linked; the rows then carry no linked Discord account. instance needs See analytics and See audit log instead of either, and still refuses flagged and linked without See profiles.

AuthorizationBearer <token>

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

In: header

Query Parameters

search?string
membership?string
banned?boolean
everBanned?boolean
profile?string
eighteenPlus?boolean
trustRank?array<string>
platform?array<string>
linked?string
flagged?boolean
seenFrom?string
Formatdate-time
seenTo?string
Formatdate-time
role?array<string>
notRole?array<string>
noRole?boolean
representing?boolean
joinedFrom?string
Formatdate-time
joinedTo?string
Formatdate-time
instance?string
Formatuuid
hereAt?array<>
notHereAt?array<>
sort?string
page?integer
Formatint32
pageSize?integer
Formatint32

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/api/people"
{  "people": [    {      "userId": "string",      "displayName": null,      "plainName": null,      "avatarThumbnailUrl": null,      "trustRank": null,      "eighteenPlus": true,      "isMember": true,      "leftAt": null,      "banned": true,      "firstSeenAt": "2019-08-24T14:15:22Z",      "lastSeenAt": "2019-08-24T14:15:22Z",      "profileRefreshedAt": null,      "notFoundAt": null,      "roleIds": [        "string"      ],      "roleNames": [        "string"      ],      "joinedAt": null,      "isRepresenting": true,      "linkedDiscord": null,      "visit": null    }  ],  "total": 0,  "page": 0,  "pageSize": 0,  "roles": [    {      "id": "string",      "name": null,      "members": 0    }  ],  "coverage": {    "known": 0,    "members": 0,    "now": "2019-08-24T14:15:22Z",    "memberList": {      "firstSweepComplete": true,      "lastSyncedAt": null,      "sweepInProgress": true,      "memberCount": 0,      "now": "2019-08-24T14:15:22Z"    }  }}

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.