List members
/api/membersThe 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.
An API key, made on Settings, API keys. Every key starts with mbk_.
In: header
Query Parameters
date-timedate-timedate-timedate-timeint32int32Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/api/members"{ "members": [ { "userId": "string", "displayName": null, "plainName": null, "avatarThumbnailUrl": null, "roleIds": [ "string" ], "roleNames": [ "string" ], "joinedAt": null, "membershipStatus": null, "visibility": null, "isRepresenting": true, "eighteenPlus": true, "trustRank": null, "lastSeenAt": null, "profileRefreshedAt": null, "leftAt": null, "linkedDiscord": null } ], "total": 0, "page": 0, "pageSize": 0, "roles": [ { "id": "string", "name": null, "members": 0 } ], "coverage": { "firstSweepComplete": true, "lastSyncedAt": null, "sweepInProgress": true, "memberCount": 0, "now": "2019-08-24T14:15:22Z" }}List group bans GET
This is the group's ban list -- everyone VRChat says is banned right now, whenever the ban was issued -- read by the ban sweep. Who banned them and why is the audit log's to say, at /api/audit/bans. Bans that stand by default; `status=lifted` shows bans a full sweep no longer listed, `status=all` both. `caseFile=written` keeps the people with a case file that stands, `caseFile=none` the rest; it needs ViewProfile and is ignored without it. Needs the `ViewAuditLog` permission.
Get membership GET
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.