Docs API Reference Members API

Members API

3 min read

List members

GET /v1/members

Query parameters:

ParameterTypeDescription
limitnumberResults per page (max 100, default 25)
offsetnumberPagination offset
statusstringFilter by status: active, banned, pending

Response:

{
  "data": [
    {
      "id": "mem_xyz789",
      "discordId": "123456789012345678",
      "username": "Lars#0001",
      "avatar": "https://cdn.discordapp.com/...",
      "joinedAt": "2025-01-15T08:30:00Z",
      "status": "active",
      "whitelisted": true
    }
  ],
  "meta": {
    "total": 1247,
    "limit": 25,
    "offset": 0
  }
}

Get a member

GET /v1/members/{id}

Update whitelist status

PATCH /v1/members/{id}/whitelist
{
  "whitelisted": true
}

Ban a member

POST /v1/members/{id}/ban
{
  "reason": "Violation of rule 3.2 — harassment",
  "permanent": false,
  "expiresAt": "2025-07-01T00:00:00Z"
}