Modbot Docs
APIAPI referenceMembers

Get membership

GET/api/members/membership

Whether they are a member now, with which roles and since when; whether the ban list holds them; and how fresh both answers are. known is false when no sweep has ever listed them as a member.

Needs the ViewMembers permission.

AuthorizationBearer <token>

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

In: header

Query Parameters

vrchatUserId*string

Also accepted as id.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/api/members/membership?vrchatUserId=string"
{  "userId": "string",  "known": true,  "isMember": true,  "roleIds": [    "string"  ],  "roleNames": [    "string"  ],  "joinedAt": null,  "membershipStatus": null,  "visibility": null,  "isRepresenting": true,  "managerNotes": null,  "firstSeenAt": null,  "lastSeenAt": null,  "leftAt": null,  "banned": true,  "bannedAt": null,  "banLiftedAt": null,  "members": {    "firstSweepComplete": true,    "lastSyncedAt": null,    "sweepInProgress": true,    "memberCount": 0,    "now": "2019-08-24T14:15:22Z"  },  "bans": {    "firstSweepComplete": true,    "lastSyncedAt": null,    "sweepInProgress": true,    "banCount": 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.

List members GET

The group's member list, as last swept, with search. Current members by default; `status=left` shows people a full sweep no longer listed, `status=all` both. `search` matches the display name and the id, case-insensitively. `role` is a 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. Sorted by join date, newest first, unless `sort=name` or `sort=seen`. `linked=linked` shows only people with a linked Discord account and `linked=not-linked` only people without; both need See profiles, as does `linkedDiscord` on each row. `joinedFrom` and `joinedTo` narrow the list to people who joined inside that stretch, which is what an unusual-activity alert links to; `seenFrom` and `seenTo` do the same for when Modbot last saw them. `eighteenPlus` and `representing` are true or false; `profile` is `fetched` or `not-fetched`. `roles` lists the group's roles with how many current members hold each. `coverage.firstSweepComplete` is false until the first full sweep has finished; the list is partial until then. Names and pictures come from the profile sync and are null for people it has not fetched yet. Needs the `ViewMembers` permission.

Get VRChat profile GET

The profile as of `lastRefreshedAt`, never fresher. `stale` says whether it is older than the sync's own threshold. `eighteenPlus` is Modbot's sticky flag: true once the person has ever been seen as 18+ verified, cleared only by a moderator -- it can disagree with `ageVerificationStatusLastSeen`, and that is the point. `refresh.pending` is true while a refresh is queued or in flight; poll this endpoint until `lastRefreshedAt` moves or `refresh.pending` clears. Needs the `ViewProfile` permission.