API Reference
Account
Get the RestoreCord account that owns your API key with the account endpoint, including the required permission, the response shape, errors and limits.
Authentication Model
RestoreCord accepts scoped API keys in the Authorization header. API keys are sent as Bearer <keyId>.<secret> and are limited by their permission list and optional IP/CIDR allowlist.
API keys are automation credentials for customer API calls. Manage API keys from the RestoreCord dashboard.
Get Account
Returns the account that owns the API key.
Auth: API key with READ_ACCOUNT.
Retrieve account metadata for the API key's account.
GET /api/v3/users{
"success": true,
"id": 123,
"username": "restorecord_user",
"email": "[email protected]",
"role": "business",
"createdAt": "2026-06-07T10:00:00.000Z",
"expiry": "2026-07-07T10:00:00.000Z"
}| Field | Type | Notes |
|---|---|---|
id | number | RestoreCord account ID. |
username | string | Account username. |
email | string | Account email address. |
role | string | Current plan. One of free, premium, business, enterprise. |
createdAt | string | ISO timestamp. |
expiry | string|null | Subscription expiry when present. |
Errors and Limits
| Status | Code | When |
|---|---|---|
| 401 | UNAUTHORIZED | Missing, invalid, revoked, or expired API key. |
| 403 | FORBIDDEN | The API key lacks READ_ACCOUNT or the request IP is not in the key's allowlist. |
| 429 | RATE_LIMITED | The request exceeded the account endpoint rate limit. |
- API-key authentication still requires each endpoint-specific permission, documented on the relevant API page.