API Reference

OverviewCopy Anchor Link

RestoreCord exposes authenticated /api/v3 endpoints for account data, custom bots, servers, migrations, members, snapshots, firewall, analytics, and webhook configuration.

Base URLCopy Anchor Link

https://restorecord.com/api/v3

Examples in the category pages show full paths beginning with /api/v3. Use JSON request bodies unless the endpoint explicitly documents Server-Sent Events or asset responses.

AuthenticationCopy Anchor Link

Every endpoint in this reference authenticates with an API key sent in the Authorization header.

Authorization: Bearer <keyId>.<secret>

API Key PermissionsCopy Anchor Link

Create, rotate, and revoke API keys from the RestoreCord dashboard. Use the API Keys guide for credential format, permission names, and safe usage guidance.

Response FormatCopy Anchor Link

Most endpoints return JSON with success: true on success. Some endpoints intentionally differ: member pull returns Server-Sent Events, preview attachment endpoints can return asset responses, and Discord helper routes may pass through Discord-shaped objects.

{
  "success": true,
  "message": "Optional message",
  "data": {}
}

ErrorsCopy Anchor Link

Errors generally return an error object with a string code and message. Validation errors may include field-level details.

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Validation failed",
    "errors": {
      "fieldName": {
        "_errors": ["Specific validation error"]
      }
    }
  }
}

Endpoint GroupsCopy Anchor Link

Route CoverageCopy Anchor Link

This reference lists every supported endpoint.

Integration NotesCopy Anchor Link

• Use the RestoreCord server id in {serverId} path params; use guildId fields for Discord guild ids.
• Treat API keys as scoped credentials. A key without the required permission receives 403.
• Handle absent optional fields. Plan gates and privacy gates remove fields rather than returning placeholder values.
• For member pulls, consume text/event-stream instead of JSON.
• For webhooks, verify X-Signature-256 against the raw request body and keep receivers idempotent.
• Only use the routes documented in this reference for API automation.