Modbot Docs
APIAPI referencePeople

Look up a person

GET/api/people/lookup

Give exactly one of vrchatUserId, discordUserId or accountId. The answer carries every account Modbot can tie to it, each with foundBy saying what tied it: asked for the one you gave, link for the proved Discord account link, account for an id recorded on a Modbot account.

Nothing is guessed. Accounts are tied only by the proved link and by the ids written on a Modbot account; display names are never compared and an id's shape is never read. An account that ties to nothing answers with itself and nulls, which is the honest answer rather than an error.

Each part needs the permission that already shows it elsewhere: the Discord side and the VRChat display name need ViewProfile, the Discord display name needs ViewMembers, and the Modbot account needs ViewOperationalLog or ManageUsers. A part you may not see is left null; canSeeAccount says whether a null Modbot account means there is none or that you may not be told.

AuthorizationBearer <token>

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

In: header

Query Parameters

vrchatUserId?string
discordUserId?string
accountId?string
Formatuuid

Response Body

application/json

application/problem+json

application/problem+json

curl -X GET "https://example.com/api/people/lookup"
{  "vrChat": null,  "discord": null,  "account": null,  "canSeeAccount": 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.

List people GET

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.

List member reports GET

What members told the mods with /report or Report to mods: open by default, or closed. Each report names who reported, who it is about, what was written and the message quoted. A report about a staff account is left out unless the caller holds Review tickets. Returns at most 500: the oldest open ones, or the most recently closed. Needs the `ViewReports` permission.