Modbot Docs
APIAPI referenceMembers

List members

GET/api/members

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.

AuthorizationBearer <token>

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

In: header

Query Parameters

search?string
role?array<string>
notRole?array<string>
noRole?boolean
status?string
sort?string
linked?string
joinedFrom?string
Formatdate-time
joinedTo?string
Formatdate-time
eighteenPlus?boolean
representing?boolean
seenFrom?string
Formatdate-time
seenTo?string
Formatdate-time
profile?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/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"  }}

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.