FiveM + external integrations

Build against the contracts AXIOS actually exposes.

The export catalog on this page is generated from the installed AXIOS bridge during deployment. It does not publish a marketing count and then show a smaller hand-picked list.

Quick start Complete export catalog Developer Docs

Current line AXIOS v1.7Bridge protocol v4Validated adapters QBCore · ESX · StandaloneRegistered contracts 190 total · 183 server + 7 client

01 · Quick start

Call AXIOS from a server resource.

Start axios-cad-bridge before your custom resource, declare the dependency, and use named exports from server-side Lua. The bridge retains the tenant/server signing secret and performs the signed HTTP transport for you.

fxmanifest.lua

fx_version 'cerulean'
game 'gta5'

dependency 'axios-cad-bridge'
server_script 'server.lua'

server.cfg

ensure axios-cad-bridge
ensure my-custom-resource

server.lua — bridge readiness

local bridge = exports['axios-cad-bridge']
local state = bridge:GetBridgeState()

if not state or not state.ready then
    print('[my-resource] AXIOS bridge is not ready')
    return
end

bridge:ValidateConnection(function(ok, data, statusCode, headers)
    if not ok then
        print(('AXIOS validation failed: HTTP %s'):format(tostring(statusCode)))
        return
    end
    print(('AXIOS connected on Protocol v%s'):format(tostring(state.protocolVersion)))
end)

Complete means complete.This build publishes 190 registered FiveM contracts and renders 190 rows below from the same source scan. The dedicated docs catalog at /docs/fivem/exports/ is generated from the same data.

02 · Integration surfaces

Use the narrowest supported surface for the job.

Named FiveM exports

Preferred for FiveM resources. The bridge handles tenant scope, signing, transport, JSON decoding and callback delivery.

Signed FiveM runtime

The bridge itself communicates with /v1/fivem/*. Use AxiosRequest only when a required runtime route has no dedicated export and your invoking resource is authorized.

External REST

The installed API exposes 5 source-discovered /v1/external/* routes for authorized external systems. See the generated REST catalog for the current deployment.

Realtime and outbound events

Use realtime invalidation or configured outbound integrations when your service should react to authoritative AXIOS changes instead of repeatedly polling.

Server-only security boundary.Do not place AXIOS tenant IDs, server keys or signing secrets in client Lua, NUI, browser JavaScript, screenshots or shared configuration files.

03 · Common recipes

Practical integration patterns.

RECORDS

Person status

Consume the authoritative person-status snapshot instead of maintaining a second local truth for warrants, flags or legal state.

server.lua

exports['axios-cad-bridge']:GetPersonStatus(personId, function(ok, status, statusCode)
    if not ok then
        print(('AXIOS lookup failed: HTTP %s'):format(tostring(statusCode)))
        return
    end
    print(json.encode(status))
end)

UNITS

Set unit status

Pass a FiveM player source when that player already has an active linked AXIOS unit, or pass a known external unit ID.

server.lua

exports['axios-cad-bridge']:SetUnitStatus(
    source,
    'en_route',
    callId,
    function(ok, unit, statusCode)
        if not ok then return end
        print('AXIOS unit updated')
    end
)

DISPATCH

Acknowledge a call

Allow AXIOS to enforce assignment and call-state rules instead of mirroring those rules in the invoking resource.

server.lua

exports['axios-cad-bridge']:AcknowledgeCall(source, callId, function(ok, result, statusCode)
    if not ok then
        print(('Unable to acknowledge call: HTTP %s'):format(tostring(statusCode)))
        return
    end
end)

Open additional integration recipes

04 · Complete source-generated reference

Every registered FiveM export in this deployment.

The installer scans the installed server and client bridge source, captures signatures and backing operations where they can be inferred, and renders every discovered registration. Duplicate export names are retained as overload registrations rather than hidden.

190rendered contracts

Search exports

190 exports shown

Server exports183

server · Core & discovery

Core & discovery

9 contracts

Export	Signature	Backing operation
`AxiosRequest`callback	`AxiosRequest(method, path, payload, callback)`	`GET /v1/fivem/modules`
`GetBridgeState`async	`GetBridgeState()`	`GET /v1/fivem/validate`
`GetBridgeVersion`async	`GetBridgeVersion()`	`GET /v1/fivem/validate`
`GetExportCount`async	`GetExportCount()`	`GET /v1/fivem/validate`
`GetExportNames`async	`GetExportNames()`	`GET /v1/fivem/validate`
`GetModules`callback	`GetModules(callback)`	`GET /v1/fivem/modules`
`GetProtocolVersion`async	`GetProtocolVersion()`	`GET /v1/fivem/validate`
`IsModuleEnabled`callback	`IsModuleEnabled(moduleName, callback)`	`GET /v1/fivem/modules`
`ValidateConnection`callback	`ValidateConnection(callback)`	`GET /v1/fivem/validate`

server · Dispatch & calls

Dispatch & calls

20 contracts

Export	Signature	Backing operation
`AcknowledgeCall`callback	`AcknowledgeCall(sourceOrExternalUnitId, callId, callback)`	`POST /v1/fivem/calls/':callId'/acknowledge`
`AddCallNote`callback	`AddCallNote(sourceOrExternalUnitId, callId, body, callback)`	`POST /v1/fivem/calls/':callId'/notes`
`AttachUnitToCall`callback	`AttachUnitToCall(sourceOrExternalUnitId, callId, role, callback)`	`POST /v1/fivem/calls/':callId'/assign`
`CloseCall`callback	`CloseCall(callId, disposition, callback)`	`POST /v1/fivem/calls/':callId'/close`
`CreateCall`callback	`CreateCall(data, callback)`	`POST /v1/fivem/calls`
`DeleteCall`callback	`DeleteCall(callId, callback)`	`POST /v1/fivem/calls/':callId'/close`
`DetachUnitFromCall`callback	`DetachUnitFromCall(sourceOrExternalUnitId, callId, callback)`	`POST /v1/fivem/calls/':callId'/detach`
`GetActiveCalls`callback	`GetActiveCalls(status, callback)`	`GET path`
`GetAssignments`callback	`GetAssignments(sourceOrExternalUnitId, callback)`	`GET /v1/fivem/units/':externalUnitId'/assignments`
`GetCall`callback	`GetCall(callId, callback)`	`GET '/v1/fivem/calls/' .. urlEncode(callId)`
`GetCallNotes`callback	`GetCallNotes(callId, callback)`	`GET /v1/fivem/calls/':callId'/notes`
`GetCalls`callback	`GetCalls(callback)`	`GET /v1/fivem/calls?limit=250`
`GetCallUnits`callback	`GetCallUnits(callId, callback)`	`GET /v1/fivem/calls/':callId'/units`
`GetUnitAssignments`callback	`GetUnitAssignments(sourceOrExternalUnitId, callback)`	`GET /v1/fivem/units/':externalUnitId'/assignments`
`HasAssignments`callback	`HasAssignments(sourceOrExternalUnitId, callback)`	`GET /v1/fivem/units/':externalUnitId'/assignments`
`IsCallActive`callback	`IsCallActive(callId, callback)`	`GET '/v1/fivem/calls/' .. urlEncode(callId)`
`IsUnitAssignedToCall`callback	`IsUnitAssignedToCall(sourceOrExternalUnitId, callId, callback)`	`GET /v1/fivem/calls/':callId'/units`
`SetCallLocation`callback	`SetCallLocation(callId, data, callback)`	`POST /v1/fivem/calls/':callId'/location`
`SetCallPriority`callback	`SetCallPriority(callId, priority, callback)`	`POST /v1/fivem/calls/':callId'/priority`
`SetCallStatus`callback	`SetCallStatus(callId, status, disposition, callback)`	`POST /v1/fivem/calls/':callId'/status`

server · Units & duty

Units & duty

13 contracts

Export	Signature	Backing operation
`ClearUnitEmergency`callback	`ClearUnitEmergency(sourceOrExternalUnitId, note, callback)`	`POST /v1/fivem/units/':externalUnitId'/emergency`
`GetLocalUnitState`async	`GetLocalUnitState(source)`	`GET /v1/fivem/units`
`GetUnit`callback	`GetUnit(sourceOrExternalUnitId, callback)`	`GET /v1/fivem/units`
`GetUnits`callback	`GetUnits(callback)`	`GET /v1/fivem/units`
`GetUnitState`async	`GetUnitState(source)`	`GET /v1/fivem/units`
`IsUnitEmergency`callback	`IsUnitEmergency(sourceOrExternalUnitId, callback)`	`POST /v1/fivem/units/':externalUnitId'/off-duty`
`IsUnitOnDuty`callback	`IsUnitOnDuty(sourceOrExternalUnitId, callback)`	`POST /v1/fivem/units/':externalUnitId'/off-duty`
`SetUnitEmergency`callback	`SetUnitEmergency(sourceOrExternalUnitId, state, note, callback)`	`POST /v1/fivem/units/':externalUnitId'/emergency`
`SetUnitLocation`callback	`SetUnitLocation(sourceOrExternalUnitId, location, callback)`	`POST /v1/fivem/units/':externalUnitId'/gps`
`SetUnitOffDuty`callback	`SetUnitOffDuty(sourceOrExternalUnitId, callback)`	`POST /v1/fivem/units/':externalUnitId'/off-duty`
`SetUnitStatus`callback	`SetUnitStatus(sourceOrExternalUnitId, status, callId, callback)`	`POST /v1/fivem/units/':externalUnitId'/status`
`SyncCharacter`callback	`SyncCharacter(source, callback)`	`GET /v1/fivem/units`
`SyncDuty`async	`SyncDuty(source)`	`GET /v1/fivem/units`

server · People & identity

People & identity

9 contracts

Export	Signature	Backing operation
`GetCitizenIdentity`callback	`GetCitizenIdentity(personId, callback)`	`GET /v1/fivem/people/':personId'/identity`
`GetPersonAddresses`callback	`GetPersonAddresses(personId, callback)`	`GET /v1/fivem/people/':personId'/addresses`
`GetPersonAliases`callback	`GetPersonAliases(personId, callback)`	`GET /v1/fivem/people/':personId'/aliases`
`GetPersonIdentity`callback	`GetPersonIdentity(personId, callback)`	`GET /v1/fivem/people/':personId'/identity`
`IsPersonActive`callback	`IsPersonActive(personId, callback)`	`POST /v1/fivem/people/':personId'/felon`
`LookupPerson`callback	`LookupPerson(query, callback)`	`GET '/v1/fivem/search/person?q=' .. urlEncode(query)`
`SearchPerson`callback	`SearchPerson(query, callback)`	`GET '/v1/fivem/search/person?q=' .. urlEncode(query)`
`SetPersonActive`callback	`SetPersonActive(personId, value, callback)`	`PATCH '/v1/fivem/people/' .. urlEncode(personId)`
`UpdatePerson`callback	`UpdatePerson(personId, data, callback)`	`PATCH '/v1/fivem/people/' .. urlEncode(personId)`

server · Flags & status

Flags & status

39 contracts

Export	Signature	Backing operation
`AddPersonFlag`callback	`AddPersonFlag(personId, data, callback)`	`POST /v1/fivem/people/':personId'/flags`
`ClearBoolean`callback	`ClearBoolean(personId, key, callback)`	`Bridge-managed callback`
`ClearFlag`callback	`ClearFlag(personId, code, data, callback)`	`POST /v1/fivem/people/':personId'/flags`
`ClearPersonBoolean`callback	`ClearPersonBoolean(personId, key, callback)`	`Bridge-managed callback`
`ClearPersonFlag`callback	`ClearPersonFlag(personId, code, data, callback)`	`POST /v1/fivem/people/':personId'/flags`
`GetBoolean`callback	`GetBoolean(personId, key, callback)`	`Bridge-managed callback`
`GetBooleanState`callback	`GetBooleanState(personId, key, callback)`	`GET personBooleanPath(personId`
`GetFlag`callback	`GetFlag(personId, code, callback)`	`POST /v1/fivem/people/':personId'/flags`
`GetFlagTypes`callback	`GetFlagTypes(callback)`	`GET /v1/fivem/flag-types`
`GetFlagValue`callback	`GetFlagValue(personId, code, callback)`	`POST /v1/fivem/people/':personId'/flags`
`GetPersonBoolean`callback	`GetPersonBoolean(personId, key, callback)`	`Bridge-managed callback`
`GetPersonBooleans`callback	`GetPersonBooleans(personId, callback)`	`GET /v1/fivem/people/':personId'/booleans`
`GetPersonBooleanState`callback	`GetPersonBooleanState(personId, key, callback)`	`GET personBooleanPath(personId`
`GetPersonFlag`callback	`GetPersonFlag(personId, code, callback)`	`POST /v1/fivem/people/':personId'/flags`
`GetPersonFlags`callback	`GetPersonFlags(personId, callback)`	`GET /v1/fivem/people/':personId'/flags`
`GetPersonFlagValue`callback	`GetPersonFlagValue(personId, code, callback)`	`POST /v1/fivem/people/':personId'/flags`
`GetPersonStatus`callback	`GetPersonStatus(personId, callback)`	`GET /v1/fivem/people/':personId'/status`
`HasAccessibilityFlag`callback	`HasAccessibilityFlag(personId, callback)`	`Bridge-managed callback`
`HasAnyFlag`callback	`HasAnyFlag(personId, callback)`	`Bridge-managed callback`
`HasCriticalFlag`callback	`HasCriticalFlag(personId, callback)`	`Bridge-managed callback`
`HasFlag`callback	`HasFlag(personId, code, callback)`	`POST /v1/fivem/people/':personId'/flags`
`HasInformationalFlag`callback	`HasInformationalFlag(personId, callback)`	`Bridge-managed callback`
`HasMedicalFlag`callback	`HasMedicalFlag(personId, callback)`	`Bridge-managed callback`
`HasPersonBoolean`callback	`HasPersonBoolean(personId, key, callback)`	`Bridge-managed callback`
`HasPersonFlag`callback	`HasPersonFlag(personId, code, callback)`	`POST /v1/fivem/people/':personId'/flags`
`HasSafetyFlag`callback	`HasSafetyFlag(personId, callback)`	`Bridge-managed callback`
`IsBooleanDefined`callback	`IsBooleanDefined(personId, key, callback)`	`Bridge-managed callback`
`IsBooleanPresent`callback	`IsBooleanPresent(personId, key, callback)`	`Bridge-managed callback`
`IsFelon`callback	`IsFelon(personId, callback)`	`Bridge-managed callback`
`IsFlagPresent`callback	`IsFlagPresent(personId, code, callback)`	`POST /v1/fivem/people/':personId'/flags`
`IsPersonBooleanDefined`callback	`IsPersonBooleanDefined(personId, key, callback)`	`Bridge-managed callback`
`IsPersonBooleanPresent`callback	`IsPersonBooleanPresent(personId, key, callback)`	`Bridge-managed callback`
`IsPersonFlagPresent`callback	`IsPersonFlagPresent(personId, code, callback)`	`POST /v1/fivem/people/':personId'/flags`
`RemovePersonFlag`callback	`RemovePersonFlag(flagId, note, callback)`	`POST /v1/fivem/person-flags/':flagId'/deactivate`
`SetBoolean`callback	`SetBoolean(personId, key, value, data, callback)`	`Bridge-managed callback`
`SetFelon`callback	`SetFelon(personId, value, reason, callback)`	`POST /v1/fivem/people/':personId'/felon`
`SetFlag`callback	`SetFlag(personId, code, present, data, callback)`	`POST /v1/fivem/people/':personId'/flags`
`SetPersonBoolean`callback	`SetPersonBoolean(personId, key, value, data, callback)`	`Bridge-managed callback`
`SetPersonFlag`callback	`SetPersonFlag(personId, code, present, data, callback)`	`POST /v1/fivem/people/':personId'/flags`

server · Licensing & eligibility

Licensing & eligibility

27 contracts

Export	Signature	Backing operation
`CheckEligibility`callback	`CheckEligibility(personId, callback)`	`GET /v1/fivem/people/':personId'/eligibility`
`GetEndorsementByType`callback	`GetEndorsementByType(personId, code, callback)`	`POST /v1/fivem/endorsements/':endorsementId'/status`
`GetEndorsementStatus`callback	`GetEndorsementStatus(personId, code, callback)`	`POST /v1/fivem/endorsements/':endorsementId'/status`
`GetEndorsementTypes`callback	`GetEndorsementTypes(callback)`	`GET /v1/fivem/endorsement-types`
`GetLicenseByType`callback	`GetLicenseByType(personId, code, callback)`	`POST /v1/fivem/licenses/':licenseId'/status`
`GetLicenseStatus`callback	`GetLicenseStatus(personId, code, callback)`	`POST /v1/fivem/licenses/':licenseId'/status`
`GetLicenseTypes`callback	`GetLicenseTypes(callback)`	`GET /v1/fivem/license-types`
`GetPersonEndorsements`callback	`GetPersonEndorsements(personId, callback)`	`GET /v1/fivem/people/':personId'/endorsements`
`GetPersonLicenses`callback	`GetPersonLicenses(personId, callback)`	`GET /v1/fivem/people/':personId'/licenses`
`HasActiveEndorsement`callback	`HasActiveEndorsement(personId, callback)`	`POST /v1/fivem/people/':personId'/felon`
`HasActiveLicense`callback	`HasActiveLicense(personId, callback)`	`Bridge-managed callback`
`HasEndorsement`callback	`HasEndorsement(personId, code, callback)`	`POST /v1/fivem/endorsements/':endorsementId'/status`
`HasLicenseType`callback	`HasLicenseType(personId, code, callback)`	`POST /v1/fivem/licenses/':licenseId'/status`
`HasRevokedLicense`callback	`HasRevokedLicense(personId, callback)`	`Bridge-managed callback`
`HasSuspendedEndorsement`callback	`HasSuspendedEndorsement(personId, callback)`	`POST /v1/fivem/people/':personId'/felon`
`HasSuspendedLicense`callback	`HasSuspendedLicense(personId, callback)`	`Bridge-managed callback`
`IsEndorsementActive`callback	`IsEndorsementActive(personId, code, callback)`	`POST /v1/fivem/endorsements/':endorsementId'/status`
`IsEndorsementPresent`callback	`IsEndorsementPresent(personId, code, callback)`	`POST /v1/fivem/endorsements/':endorsementId'/status`
`IsEndorsementSuspended`callback	`IsEndorsementSuspended(personId, code, callback)`	`POST /v1/fivem/endorsements/':endorsementId'/status`
`IsLicenseActive`callback	`IsLicenseActive(personId, code, callback)`	`POST /v1/fivem/licenses/':licenseId'/status`
`IsLicenseRevoked`callback	`IsLicenseRevoked(personId, code, callback)`	`POST /v1/fivem/licenses/':licenseId'/status`
`IsLicenseSuspended`callback	`IsLicenseSuspended(personId, code, callback)`	`POST /v1/fivem/licenses/':licenseId'/status`
`IsLicenseTypePresent`callback	`IsLicenseTypePresent(personId, code, callback)`	`POST /v1/fivem/licenses/':licenseId'/status`
`SetEndorsementStatus`callback	`SetEndorsementStatus(endorsementId, status, reason, callback)`	`POST /v1/fivem/endorsements/':endorsementId'/status`
`SetEndorsementTypeStatus`callback	`SetEndorsementTypeStatus(personId, code, status, data, callback)`	`POST /v1/fivem/people/':personId'/endorsements/type/':code'/status`
`SetLicenseStatus`callback	`SetLicenseStatus(licenseId, status, reason, callback)`	`POST /v1/fivem/licenses/':licenseId'/status`
`SetLicenseTypeStatus`callback	`SetLicenseTypeStatus(personId, code, status, data, callback)`	`POST /v1/fivem/people/':personId'/licenses/type/':code'/status`

server · Vehicles

Vehicles

12 contracts

Export	Signature	Backing operation
`CreateVehicle`callback	`CreateVehicle(data, callback)`	`POST /v1/fivem/vehicles`
`GetPersonVehicles`callback	`GetPersonVehicles(personId, callback)`	`GET /v1/fivem/people/':personId'/vehicles`
`GetVehicle`callback	`GetVehicle(vehicleId, callback)`	`GET '/v1/fivem/vehicles/' .. urlEncode(vehicleId)`
`GetVehicleByPlate`callback	`GetVehicleByPlate(plate, callback)`	`GET '/v1/fivem/vehicles/' .. urlEncode(vehicleId)`
`GetVehicleOwner`callback	`GetVehicleOwner(plate, callback)`	`GET '/v1/fivem/firearms/' .. urlEncode(firearmId)`
`HasStolenVehicle`callback	`HasStolenVehicle(personId, callback)`	`POST /v1/fivem/people/':personId'/felon`
`HasVehicle`callback	`HasVehicle(personId, callback)`	`POST /v1/fivem/people/':personId'/felon`
`IsVehicleStolen`callback	`IsVehicleStolen(plate, callback)`	`POST /v1/fivem/vehicles/stolen`
`LookupPlate`callback	`LookupPlate(plate, callback)`	`GET '/v1/fivem/search/warrant/' .. urlEncode(number)`
`SearchVehicle`callback	`SearchVehicle(plate, callback)`	`GET '/v1/fivem/search/warrant/' .. urlEncode(number)`
`SetVehicleStolen`callback	`SetVehicleStolen(plate, value, reason, callback)`	`POST /v1/fivem/vehicles/stolen`
`UpdateVehicle`callback	`UpdateVehicle(vehicleId, data, callback)`	`PATCH '/v1/fivem/vehicles/' .. urlEncode(vehicleId)`

server · Firearms

Firearms

12 contracts

Export	Signature	Backing operation
`CreateFirearm`callback	`CreateFirearm(data, callback)`	`POST /v1/fivem/firearms`
`GetFirearm`callback	`GetFirearm(firearmId, callback)`	`GET '/v1/fivem/firearms/' .. urlEncode(firearmId)`
`GetFirearmBySerial`callback	`GetFirearmBySerial(serial, callback)`	`GET '/v1/fivem/firearms/' .. urlEncode(firearmId)`
`GetFirearmOwner`callback	`GetFirearmOwner(serial, callback)`	`GET '/v1/fivem/warrants/' .. urlEncode(warrantId)`
`GetPersonFirearms`callback	`GetPersonFirearms(personId, callback)`	`GET /v1/fivem/people/':personId'/firearms`
`HasFirearm`callback	`HasFirearm(personId, callback)`	`POST /v1/fivem/people/':personId'/felon`
`HasStolenFirearm`callback	`HasStolenFirearm(personId, callback)`	`POST /v1/fivem/people/':personId'/felon`
`IsFirearmStolen`callback	`IsFirearmStolen(serial, callback)`	`POST /v1/fivem/firearms/stolen`
`LookupFirearm`callback	`LookupFirearm(serial, callback)`	`GET '/v1/fivem/search/warrant/' .. urlEncode(number)`
`SearchFirearm`callback	`SearchFirearm(serial, callback)`	`GET '/v1/fivem/search/warrant/' .. urlEncode(number)`
`SetFirearmStolen`callback	`SetFirearmStolen(serial, value, reason, callback)`	`POST /v1/fivem/firearms/stolen`
`UpdateFirearm`callback	`UpdateFirearm(firearmId, data, callback)`	`PATCH '/v1/fivem/firearms/' .. urlEncode(firearmId)`

server · Warrants & BOLOs

Warrants & BOLOs

16 contracts

Export	Signature	Backing operation
`CreateBolo`callback	`CreateBolo(data, callback)`	`POST /v1/fivem/bolos`
`CreateWarrant`callback	`CreateWarrant(data, callback)`	`POST /v1/fivem/warrants`
`GetActiveWarrantsAndBolos`callback	`GetActiveWarrantsAndBolos(callback)`	`GET /v1/fivem/records/active-warrants-bolos`
`GetAllWarrantsAndBolos`callback	`GetAllWarrantsAndBolos(callback)`	`GET /v1/fivem/records/warrants-bolos`
`GetBolo`callback	`GetBolo(boloId, callback)`	`GET '/v1/fivem/bolos/' .. urlEncode(boloId)`
`GetPersonBolos`callback	`GetPersonBolos(personId, callback)`	`GET /v1/fivem/people/':personId'/bolos`
`GetPersonWarrants`callback	`GetPersonWarrants(personId, callback)`	`GET /v1/fivem/people/':personId'/warrants`
`GetWarrant`callback	`GetWarrant(warrantId, callback)`	`GET '/v1/fivem/warrants/' .. urlEncode(warrantId)`
`HasActiveBolo`callback	`HasActiveBolo(personId, callback)`	`Bridge-managed callback`
`HasActiveWarrant`callback	`HasActiveWarrant(personId, callback)`	`Bridge-managed callback`
`SearchBolo`callback	`SearchBolo(number, callback)`	`GET '/v1/fivem/search/bolo/' .. urlEncode(number)`
`SearchWarrant`callback	`SearchWarrant(number, callback)`	`GET '/v1/fivem/search/warrant/' .. urlEncode(number)`
`SetActiveBolo`callback	`SetActiveBolo(personId, value, data, callback)`	`POST /v1/fivem/people/':personId'/active-bolo`
`SetActiveWarrant`callback	`SetActiveWarrant(personId, value, data, callback)`	`POST /v1/fivem/people/':personId'/active-warrant`
`SetBoloStatus`callback	`SetBoloStatus(boloId, status, callback)`	`POST /v1/fivem/bolos/':boloId'/status`
`SetWarrantStatus`callback	`SetWarrantStatus(warrantId, status, reason, callback)`	`POST /v1/fivem/warrants/':warrantId'/status`

server · Reports & records

Reports & records

10 contracts

Export	Signature	Backing operation
`CreateFieldInterview`callback	`CreateFieldInterview(data, callback)`	`POST /v1/fivem/field-interviews`
`GetFieldInterviewsByPerson`callback	`GetFieldInterviewsByPerson(personId, callback)`	`GET '/v1/fivem/field-interviews/person/' .. urlEncode(personId)`
`GetPersonArrests`callback	`GetPersonArrests(personId, callback)`	`GET /v1/fivem/people/':personId'/arrests`
`GetPersonCitations`callback	`GetPersonCitations(personId, callback)`	`GET /v1/fivem/people/':personId'/citations`
`GetPersonConvictions`callback	`GetPersonConvictions(personId, callback)`	`GET /v1/fivem/people/':personId'/convictions`
`GetPersonReports`callback	`GetPersonReports(personId, callback)`	`GET /v1/fivem/people/':personId'/reports`
`HasArrestRecord`callback	`HasArrestRecord(personId, callback)`	`POST /v1/fivem/people/':personId'/felon`
`HasCitationRecord`callback	`HasCitationRecord(personId, callback)`	`POST /v1/fivem/people/':personId'/felon`
`HasConvictionRecord`callback	`HasConvictionRecord(personId, callback)`	`POST /v1/fivem/people/':personId'/felon`
`HasFelonyConviction`callback	`HasFelonyConviction(personId, callback)`	`POST /v1/fivem/people/':personId'/felon`

server · Parole & supervision

Parole & supervision

9 contracts

Export	Signature	Backing operation
`CreateParoleCheckIn`callback	`CreateParoleCheckIn(caseId, data, callback)`	`POST /v1/fivem/parole/cases/':caseId'/check-ins`
`CreateParoleViolation`callback	`CreateParoleViolation(caseId, data, callback)`	`POST /v1/fivem/parole/cases/':caseId'/violations`
`GetParoleCases`callback	`GetParoleCases(personId, callback)`	`GET '/v1/fivem/parole/people/' .. urlEncode(personId)`
`GetParoleCheckIns`callback	`GetParoleCheckIns(caseId, callback)`	`GET /v1/fivem/parole/cases/':caseId'/check-ins`
`GetParoleStatus`callback	`GetParoleStatus(personId, callback)`	`GET '/v1/fivem/parole/people/' .. urlEncode(personId)`
`GetParoleViolations`callback	`GetParoleViolations(caseId, callback)`	`GET /v1/fivem/parole/cases/':caseId'/violations`
`HasParoleViolation`callback	`HasParoleViolation(personId, callback)`	`Bridge-managed callback`
`IsOnParole`callback	`IsOnParole(personId, callback)`	`Bridge-managed callback`
`SetOnParole`callback	`SetOnParole(personId, value, data, callback)`	`POST /v1/fivem/parole/people/':personId'/active-state`

server · Civilian & intake

Civilian & intake

3 contracts

Export	Signature	Backing operation
`Create311Call`callback	`Create311Call(data, callback)`	`POST /v1/fivem/311`
`Create911Call` overload 1/2callback	`Create911Call(data, callback)`	`POST /v1/fivem/911`
`Create911Call` overload 2/2callback	`Create911Call(source, data, callback)`	`POST /v1/fivem/calls`

server · Mapping & jurisdiction

Mapping & jurisdiction

1 contract

Export	Signature	Backing operation
`GetJurisdiction`callback	`GetJurisdiction(callback)`	`GET /v1/fivem/jurisdiction`

server · Other

Other

3 contracts

Export	Signature	Backing operation
`IsReady`async	`IsReady()`	`GET /v1/fivem/validate`
`SetUsesSignLanguage`callback	`SetUsesSignLanguage(personId, present, data, callback)`	`POST /v1/fivem/licenses/':licenseId'/status`
`UsesSignLanguage`callback	`UsesSignLanguage(personId, callback)`	`POST /v1/fivem/licenses/':licenseId'/status`

Client exports7

client · Dispatch & calls

Dispatch & calls

2 contracts

Export	Signature	Backing operation
`GetAssignments`sync	`GetAssignments()`	`Local bridge state`
`HasAssignments`sync	`HasAssignments()`	`Local bridge state`

client · Other

Other

5 contracts

Export	Signature	Backing operation
`CloseMdt`sync	`CloseMdt()`	`Local bridge state`
`IsMdtOpen`sync	`IsMdtOpen()`	`Local bridge state`
`OpenMdt`sync	`OpenMdt()`	`Local bridge state`
`SetMdtOpen`sync	`SetMdtOpen(value)`	`Local bridge state`
`ToggleMdt`sync	`ToggleMdt()`	`Local bridge state`

Machine-readable catalog.The same generated data is published at /docs/catalog/exports.json, with build totals in /docs/_meta.json.

05 · Unit resolution

Know when to pass a player source.

Exports using a sourceOrExternalUnitId argument accept either a numeric FiveM server player source or a known external AXIOS unit ID. The player-source path requires an active AXIOS unit mapping; a missing mapping is returned as a normal integration failure rather than guessed.

Player source

Use when the action belongs to the connected player whose duty session is already established by AXIOS.

SetUnitStatus(source, 'on_scene', callId, callback)

External unit ID

Use when a server-side system is operating on a known AXIOS unit identifier and the calling resource is authorized.

GetUnit('server-key:character-id', callback)

06 · Protocol v4

Signed transport stays inside the bridge.

Protocol v4 signs the tenant, server, timestamp, idempotency key, HTTP method, route and request-body hash. Named exports are the preferred developer surface because they keep this implementation detail on the server.

Signed request inputs

X-CAD-Tenant-ID
X-CAD-Server-Key
X-CAD-Timestamp
X-CAD-Signature
X-Idempotency-Key

Canonical v4 input

v4
<timestamp>
<tenant-id>
<server-key>
<idempotency-key>
<HTTP-METHOD>
<path>
<sha256(body)>

Read full security documentation

07 · Framework support

One AXIOS contract across supported server frameworks.

QBCoreNormalized identity and duty integration through the bridge adapter.

ESXThe same downstream AXIOS export contracts through the ESX adapter.

StandaloneConfigured identity resolution without a framework dependency.

Protocol v4The transport contract remains the same regardless of the selected framework adapter.

08 · Errors & versioning

Do not convert a rejected AXIOS action into local success.

HTTP-backed exports use function(ok, data, statusCode, headers). Check ok, retain the returned status/correlation context for diagnostics, and use idempotent mutation patterns when retrying a request that may have reached the server.

Validation / authorizationExpect a 4xx response and a structured error. Correct the request or permission/state issue before retrying.

Unavailable serviceTreat the operation as failed. Do not fabricate a CAD state change locally.

CompatibilityUse GetBridgeState(), GetBridgeVersion() and capability-oriented checks when your integration depends on a particular bridge behavior.

Read errors & versioning

Documentation integrity

The published count and rendered list share one source.

During installation, AXIOS scans the deployed bridge and API route source before replacing the public website. Verification then compares the generated JSON catalog, rendered rows, page totals and a fresh rescan of the installed bridge. If those disagree, deployment fails and the website is rolled back instead of publishing a misleading developer count.