Modbot Docs
APIAPI referenceDiscord

List Discord members

GET/api/discord/members

Members in the server by default; state=left shows people who left, state=all both. search matches the display name, username, global name, nickname and the id, case-insensitively. role is a Discord 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. bot, pending, timedOut and boosting are true or false. joinedFrom and joinedTo narrow to people who joined inside that stretch. linked=linked shows only people with a linked VRChat account and linked=not-linked only people without; both need See profiles, as does linkedVRChat on each member. Newest joiners first unless sort=oldest or sort=name. roles lists the server's roles with how many current members hold each.

coverage.listedAt is null until the bot has read the whole member list once; the list is partial until then.

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
status?string

Also accepted as state.

role?array<string>
notRole?array<string>
noRole?boolean
linked?string
bot?boolean
pending?boolean
timedOut?boolean
boosting?boolean
joinedFrom?string
Formatdate-time
joinedTo?string
Formatdate-time
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/discord/members"
{  "members": [    {      "userId": "string",      "username": "string",      "displayName": "string",      "plainName": null,      "globalName": null,      "nickname": null,      "avatarUrl": null,      "isBot": true,      "joinedAt": null,      "leftAt": null,      "roles": [        {          "id": "string",          "name": null,          "color": 0        }      ],      "timedOutUntil": null,      "isPending": true,      "boostingSince": null,      "firstSeenAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "linkedVRChat": null    }  ],  "total": 0,  "page": 0,  "pageSize": 0,  "coverage": {    "guildId": null,    "listedAt": null,    "inServer": 0,    "now": "2019-08-24T14:15:22Z"  },  "roles": [    {      "id": "string",      "name": null,      "color": 0,      "members": 0    }  ]}

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.