Members

OverviewCopy Anchor Link

Member endpoints expose verified member records, single-member pull operations, and unauthorized cleanup. Server path params use internal RestoreCord server IDs; list and unauthorized routes also accept all.

List MembersCopy Anchor Link

Returns member summaries, counts, pagination, and pullable/unauthorized totals.

GET /api/v3/servers/{serverId}/members

{
  "success": true,
  "members": [
    {
      "id": 987,
      "serverId": "42",
      "userId": "123456789012345678",
      "username": "alice#0000",
      "avatar": "avatar-hash",
      "country": "US",
      "createdAt": "2026-06-07T10:30:00.000Z",
      "guildId": "111111111111111111",
      "guildName": "Community",
      "unauthorized": false
    }
  ],
  "total": 1,
  "pullable": 1,
  "unauthorized": 0,
  "currentPage": 1,
  "maxPages": 1
}

• Very deep pagination is rejected; use filters to narrow results.
• For serverId=all, servers shared with the API key's account are included only when that account has the VIEW_MEMBERS sub-user permission.
• IP and email searches follow the same rules as the member details: the server owner's plan must be Premium or higher for IP and Business or higher for email, and on shared servers the account needs the View Member Details sub-user permission. For serverId=all, servers that don't meet these rules are left out of the results. If no server meets them, the request returns 403 INSUFFICIENT_PERMISSIONS.
• Country filters must be a supported two-letter ISO country code.

Unauthorized MembersCopy Anchor Link

Unauthorized members removed your bot from their Discord account, so they can no longer be pulled until they verify again.

Count unauthorized membersCopy Anchor Link

Returns unauthorized member counts for one server or all accessible servers.

GET /api/v3/servers/{serverId}/members/unauthorized

{
  "success": true,
  "count": 12,
  "serverId": "all",
  "breakdown": [
    { "serverId": "42", "guildId": "111111111111111111", "serverName": "Community", "count": 12 }
  ]
}

Delete unauthorized membersCopy Anchor Link

Deletes unauthorized member records. Use dryRun to preview counts first.

DELETE /api/v3/servers/{serverId}/members/unauthorized

{
  "success": true,
  "dryRun": true,
  "wouldRemove": 12,
  "message": "Dry run: Would remove 12 unauthorized members."
}

{
  "success": true,
  "removed": 12,
  "message": "Successfully removed 12 unauthorized members.",
  "serverId": "42"
}

Lookup MemberCopy Anchor Link

Returns one entry per server owned by the API key's account that contains the Discord user. Servers shared with the account through sub-user access are not searched for API keys. Not-found lookups return servers: [].

GET /api/v3/members/{userId}

{
  "success": true,
  "servers": [
    {
      "serverId": 42,
      "guildId": "111111111111111111",
      "serverName": "Community",
      "hasFullAccess": true,
      "member": {
        "id": 987,
        "userId": "123456789012345678",
        "username": "alice#0000",
        "avatar": "avatar-hash",
        "joinedAt": "2026-06-07T10:30:00.000Z",
        "country": "US",
        "unauthorized": false,
        "ip": "203.0.113.***",
        "location": { "country": "United States", "vpn": false }
      }
    }
  ]
}

Resolve MemberCopy Anchor Link

Returns one server/member entry for a member record ID (member.id). API keys can only resolve members of servers owned by the key's account; other members return 404.

GET /api/v3/members/resolve/{memberId}

{
  "success": true,
  "server": {
    "serverId": 42,
    "guildId": "111111111111111111",
    "serverName": "Community",
    "hasFullAccess": true,
    "member": {
      "id": 987,
      "serverId": "42",
      "userId": "123456789012345678",
      "username": "alice#0000",
      "unauthorized": false
    }
  }
}

Pull MemberCopy Anchor Link

Auth: API key with SERVER_PULL. The key's account must own the server, or have the pull_members and view_members sub-user permissions on it. The response is text/event-stream, not JSON. Invalid IDs and a missing permission bit return a JSON error; every other failure (server access, member not found, unauthorized member, bot, guild or Discord errors) arrives as an error event in a 200 stream. See Pull One Member for every message.

Pulls one stored member into a target Discord guild and streams progress events.

PUT /api/v3/servers/{serverId}/members/{userId}

event: info
data: {"time":1780837800000,"success":true,"message":"Started Pulling..."}

event: info
data: {"time":1780837801000,"success":true,"message":"Successfully Pulled"}

SSE EventsCopy Anchor Link

Delete MemberCopy Anchor Link

Auth: API key with WRITE_MEMBERS. The key's account must own the server; sub-user access is not accepted.

Deletes one member record and removes the verified role best-effort through Discord.

DELETE /api/v3/servers/{serverId}/members/{userId}

{
  "success": true,
  "message": "Member removed from server."
}

Member GuildsCopy Anchor Link

Returns the member's Discord servers. Auth: API key with READ_MEMBERS. Requires a valid serverId query, VIEW_MEMBERS access to that server, a Business or Enterprise server owner plan, and the guilds scope enabled for the server.

GET /api/v3/members/{userId}/guilds

{
  "success": true,
  "guilds": [
    { "id": "999999999999999999", "name": "Other Guild", "icon": null }
  ],
  "cached": false
}

Status and ErrorsCopy Anchor Link

• Use GET /members/{userId} for Discord-user lookup and GET /members/resolve/{memberId} for member record ID lookup.
• Use DELETE /members/unauthorized?dryRun=true before destructive cleanup.
• Handle pull responses as SSE, not JSON.