← Home
⌕
Ask on Discord
General ER:LC FiveM API
Developers
DOCUMENTATION/Public API v1

Errors

The API v1 error format and its codes, one by one.

An error carries the real HTTP status and a body with code (stable, for your program), message (in English, for people; it may change) and request_id, the same as the X-Request-Id header. When it is known which field failed or what is missing, it goes in details. Always branch on the HTTP status and on code, never on the message.
NOTE An error carries the real HTTP status and a body with code (stable, for your program), message (in English, for people; it may change) and request_id, the same as the X-Request-Id header. When it is known which field failed or what is missing, it goes in details. Always branch on the HTTP status and on code, never on the message.
HTTP/1.1 403 Forbidden X-Request-Id: req_k3v9x0q2m7w1c8r5t4ya { "error": { "code": "missing_scope", "message": "This API key lacks the required scope: dispatch:write.", "request_id": "req_k3v9x0q2m7w1c8r5t4ya", "details": { "required_scopes": ["dispatch:write"] } } }
HTTP/1.1 403 Forbidden X-Request-Id: req_k3v9x0q2m7w1c8r5t4ya { "error": { "code": "missing_scope", "message": "This API key lacks the required scope: dispatch:write.", "request_id": "req_k3v9x0q2m7w1c8r5t4ya", "details": { "required_scopes": ["dispatch:write"] } } }
NOTE HTTP/1.1 403 Forbidden X-Request-Id: req_k3v9x0q2m7w1c8r5t4ya { "error": { "code": "missing_scope", "message": "This API key lacks the required scope: dispatch:write.", "request_id": "req_k3v9x0q2m7w1c8r5t4ya", "details": { "required_scopes": ["dispatch:write"] } } }
The codes
NOTE The codes
NOTE
400: api_key_in_query (the key was in the URL or the body), invalid_request, invalid_limit, invalid_order, invalid_cursor, invalid_json or invalid_idempotency_key.
401: missing_api_key, invalid_api_key, api_key_revoked or api_key_expired.
403: missing_scope, ip_not_allowed, plan_required (the server's plan does not include the API) or module_off (the MDT module needed is turned off in that corporation).
404: not_found (it does not exist on this server; an id from another server too) or route_not_found (the route does not exist in v1).
405: method_not_allowed.
409: idempotency_in_progress, limit_reached or conflict.
422: validation_failed or unknown_field (details.field says which one), idempotency_key_reused, and each route's own codes, such as events_required or invalid_event when creating a webhook.
429: rate_limited, with Retry-After (Rate limits and pagination).
500: internal_error. Give the request_id to support.
The possible errors of each route are on its reference page, starting at API v1: server.
NOTE The possible errors of each route are on its reference page, starting at API v1: server.
← Previous
Keys and scopes
Next →
Rate limits and pagination
33 / 54 Something missing here →
STEP 1 · PLAN ×
Pick your server's plan
After payment you name it and we configure it together. You can change plan whenever you like.
FREE1 OF 1 LEFT Up to 500 characters and basic CAD. To try it. 0 €
PLUSMONTHLY Full CAD, moderation, activity and economy. 5,99 €
PREMIUMER:LC & FIVEM Everything in PLUS, FiveM included and higher limits. 12,99 €
ENTERPRISEPERMANENT All of PREMIUM forever, self-hosted, never a fee. Contact
Continue to payment
Cancel any time · 14-day withdrawal right, unless you ask to start straight away
Confirm and pay
ER:LC PREMIUM
Monthly · one licence
12,99 €
EMAIL
CARD
Back
In development — unavailable
Blixye is in development: services can’t be purchased yet.Secure payment · VAT included
Name your server
This is the name your players see in the launcher and on Discovery. You can change it whenever.
SERVER NAME
It gets a short code, like SKY-T2Q, to link the launcher.
NEXT Once created we open the setup guide: launcher, Discord and modules in three steps.
Back
Create the server
Type at least 3 characters.
STEP 1 OF 3 · GUIDE ×
1. Send your people the launcher
It is the only thing they install, and only once. They sign in with Discord, we verify their Roblox account and the overlay shows over the session.
Go to the download
2. Create your departments
Police, sheriff, fire or whatever you run. Each with its ranks and permissions: that decides who can punish, clock in or read records.
3. Open the server
With the first duty shift the calls, activity and economy start filling up. From there you just tune it.
Back
Next
⌕ ESC
In-game overlay Radio, sheet and dispatch over the session, no alt-tab. ER:LC CAD and departments Queued calls, units with status and rosters with ranks. ER:LC Moderation and appeals Punishments with context, logs and appeals that do not get lost. ER:LC Staff activity Quotas per rank, shifts and an automatic weekly report. ER:LC Economy and businesses Accounts, payroll, player businesses and inventory. ER:LC Blixye Framework The core: characters, permissions, database and QBCore and ESX bridge. FiveM Inventory Weight, containers and safe player trades. FiveM Police MDT Records, fines, warrants and plate lookups. FiveM Banking Accounts, transfers, payroll and business accounts. FiveM Jobs Shifts, payroll and per-company hierarchy. FiveM Garages Vehicle ownership, persistent damage and impound. FiveM Housing Buying, renting, furniture and personal storage. FiveM Phone Messages, calls, apps and in-world socials. FiveM EMS Per-limb injuries, treatment and a hospital with beds. FiveM All the scripts All eight scripts unlimited, as a permanent purchase or a subscription. FiveM Install Blixye on ER:LC From an empty server to the first duty shift, without touching a game file. Docs Install the FiveM framework The zip, the SQL and your current base bridge, in the right order. Docs Your first week What to set up each day so you do not end up with twenty half-done things. Docs CAD and dispatch Calls, units and priorities inside the overlay. Docs Moderation and appeals Punishments with evidence, appeals and the log that covers you. Docs Activity and shifts Hours, quotas and who is really patrolling. Docs Scripts and free version What each script free version limits and what the full one opens. Docs QBCore and ESX bridge Living with your current base without duplicating players or money. Docs Performance Where to look when the server stutters. Docs
Nothing by that name. Try “inventory”, “CAD” or “licences”.
↵ open CTRL K search 37 results
ROTATE THE KEY ×
! The current key stops working the moment you confirm. This cannot be undone.
current key → new key on confirm
Paste the new key into the script config.
Restart the resource: refresh and ensure.
Until you do, the script will not load.
Yes, rotate the key Cancel
What each plan includes ×
FREE
DISCORD
PLUS
PREMIUM
ENTERPRISE
Price
Free
2,99 €/mo
5,99 €/mo
12,99 €/mo
Contact
GENERAL
Characters stored
500
—
5000
∞
∞
Custom invite code
—
✓
✓
✓
✓
CAD
Max corporations
2
—
6
∞
∞
Max subdivisions
0
—
6
∞
∞
MDT data wipe
1 month
—
1 year
Never
Never
MDT access
Complete
—
Complete
Complete
Complete
Logs history
7 days
—
90 days
∞
∞
Data export
—
—
✓
✓
✓
Investigations
—
—
✓
✓
✓
Evidence storage
—
—
Unmetered
Unmetered
Unmetered
Custom laws
50
—
150
∞
∞
Real-time map
—
—
✓
✓
✓
Bodycam
—
—
✓
✓
✓
Realtime map location
—
—
✓
✓
✓
Advanced search
—
—
✓
✓
✓
Radio channels (Discord VC)
10
—
50
100
∞
Roles per corporation
15
—
50
∞
∞
BANK
Bank accounts
1 per char
—
3 per char
6 per char
12 per char
Transfers
✓
—
✓
✓
✓
Transaction history
✓
—
✓
✓
✓
Cards per account
1
—
2
3
5
Timed cards
Fixed durations
—
✓
✓
✓
Usage-based cards
—
—
Max 5 per char
✓
✓
Role rewards
✓
—
✓
✓
✓
Allow negative balance
—
—
✓
✓
✓
Scheduled transfers
—
—
✓
✓
✓
Player debts
—
—
✓
✓
✓
Per-operation limits
—
—
✓
✓
✓
Shared accounts
Max 2 members
—
Max 5 members
∞
∞
ADMIN
Player heatmap
—
—
✓
✓ more precise
✓ more precise
Max forms
3
5
10
∞
∞
Your server on the phone
—
—
✓
✓
✓
Max admin roles
owner +2
owner +5
owner +10
∞
∞
Priority support
—
✓
✓
✓
✓
Staff audit log history
7 days
30 days
90 days
∞
∞
Beta features
—
✓
✓
✓
✓
Create server
Character and storage addons stack on any plan.
Cookies ESSENTIAL ONLY
We only use the essential ones: your session, sign-in security and your language. There is no analytics and no advertising, so there is nothing to accept or reject.
Got it
Cookie policy