Dispatch & LEO API

Retrieve all pending calls for a community. Returns calls that have not yet been assigned or resolved.

Query Parameters

Response

[
  {
    "_id": "665a1b2c3d4e5f6a7b8c9d0e",
    "callType": "Traffic Stop",
    "location": "Main St & 5th Ave",
    "caller": "Anonymous",
    "description": "Erratic driving reported",
    "status": "pending",
    "priority": "normal",
    "postal": "345",
    "communityId": "663f1a2b3c4d5e6f7a8b9c0d",
    "createdAt": "2025-06-01T14:30:00.000Z"
  }
]

Get a single call with full details including populated references for assigned units, attached civilians, and vehicles.

Path Parameters

Response

{
  "_id": "665a1b2c3d4e5f6a7b8c9d0e",
  "callType": "Traffic Stop",
  "location": "Main St & 5th Ave",
  "caller": "John Doe",
  "description": "Erratic driving reported",
  "status": "on-scene",
  "priority": "high",
  "postal": "345",
  "communityId": "663f1a2b3c4d5e6f7a8b9c0d",
  "assignedUnits": [
    { "_id": "unit1", "unitName": "1-Adam-12", "status": "on-scene" }
  ],
  "attachedCivilians": [
    { "_id": "civ1", "firstName": "Jane", "lastName": "Smith", "licenseNumber": "DL-12345" }
  ],
  "attachedVehicles": [
    { "_id": "veh1", "plate": "ABC1234", "make": "Honda", "model": "Civic", "year": "2020" }
  ],
  "notes": [
    { "text": "Driver cooperative", "createdBy": "Officer Adams", "createdAt": "2025-06-01T14:35:00.000Z" }
  ],
  "createdAt": "2025-06-01T14:30:00.000Z",
  "updatedAt": "2025-06-01T14:45:00.000Z"
}

Create a new call for service. A new call starts with pending status by default.

Request Body

Example Request

{
  "callType": "Suspicious Activity",
  "location": "1200 Oak Avenue",
  "communityId": "663f1a2b3c4d5e6f7a8b9c0d",
  "caller": "Anonymous",
  "description": "Person looking into car windows in parking lot",
  "priority": "normal",
  "postal": "221"
}

Response 201

{
  "success": true,
  "call": {
    "_id": "665a1b2c3d4e5f6a7b8c9d0e",
    "callType": "Suspicious Activity",
    "location": "1200 Oak Avenue",
    "status": "pending",
    "priority": "normal",
    "communityId": "663f1a2b3c4d5e6f7a8b9c0d",
    "createdAt": "2025-06-01T14:30:00.000Z"
  }
}

Update an existing call. All fields are optional — only provided fields will be updated.

Request Body

Example Request

{
  "description": "Updated: suspect now wearing a red jacket",
  "priority": "high"
}

Permanently delete a call. Admin only. Use the status update endpoint to close or cancel calls during normal operations.

Update only the status of a call. This is the preferred method for progressing calls through the status lifecycle.

Request Body

Example Request

{
  "status": "enroute"
}

Attach a civilian record to a call. You can identify the civilian by ID, license number, or full name.

Request Body (one of the following)

Example — By License Number

{
  "licenseNumber": "DL-12345"
}

Example — By Name

{
  "firstName": "Jane",
  "lastName": "Smith"
}

Attach a vehicle record to a call. Identify the vehicle by ID or plate number.

Request Body (one of the following)

Example

{
  "plate": "ABC1234"
}

Add a dispatcher or officer note to a call. Notes are appended chronologically and include the author and timestamp.

Request Body

Example Request

{
  "text": "Suspect fled on foot heading northbound"
}

Add or remove a unit from a call's assigned units list.

Request Body

Example — Add Unit

{
  "action": "add",
  "unitId": "665b2c3d4e5f6a7b8c9d0e1f",
  "unitName": "1-Adam-12"
}

Example — Remove Unit

{
  "action": "remove",
  "unitId": "665b2c3d4e5f6a7b8c9d0e1f",
  "unitName": "1-Adam-12"
}

Get all active units for a community. Returns unit status, assigned calls, and current information.

Query Parameters

Response

[
  {
    "_id": "665b2c3d4e5f6a7b8c9d0e1f",
    "unitName": "1-Adam-12",
    "status": "available",
    "job": "police",
    "communityId": "663f1a2b3c4d5e6f7a8b9c0d",
    "assignedCalls": ["665a1b2c3d4e5f6a7b8c9d0e"]
  }
]

Update a unit's real-time location for the FiveM livemap. This endpoint is designed for high-frequency calls from the FiveM server.

Request Body

Example Request

// Header: x-api-key: fvm_xxxxx
{
  "unitId": "officer_42",
  "unitName": "1-Adam-12",
  "x": -1042.5,
  "y": -2745.3,
  "z": 21.3,
  "heading": 180.0,
  "job": "police",
  "status": "patrolling",
  "postal": "345",
  "communityId": "663f1a2b3c4d5e6f7a8b9c0d"
}

Get all tracked unit locations for the livemap display. Returns the most recent position data for every active unit.

Query Parameters

Response

[
  {
    "unitId": "officer_42",
    "unitName": "1-Adam-12",
    "x": -1042.5,
    "y": -2745.3,
    "z": 21.3,
    "heading": 180.0,
    "job": "police",
    "status": "patrolling",
    "postal": "345",
    "updatedAt": "2025-06-01T14:30:05.000Z"
  }
]

Remove a unit from location tracking. Typically called when a unit goes off-duty or disconnects from the FiveM server.

Path Parameters

Get all active 911 calls for the dispatch board. Returns open emergency calls awaiting response or currently being serviced.

Query Parameters

Response

[
  {
    "_id": "665c3d4e5f6a7b8c9d0e1f2a",
    "callType": "911 Emergency",
    "location": "Legion Square",
    "caller": "Civilian #4421",
    "description": "Shots fired near the fountain",
    "status": "pending",
    "priority": "high",
    "postal": "110",
    "assignedUnits": [],
    "createdAt": "2025-06-01T14:45:00.000Z"
  }
]

Get 911 call markers for map display. Returns location data formatted for rendering on the dispatch livemap.

Query Parameters

Assign one or more units to a 911 call. Accepts either unit IDs or unit names for flexible assignment.

Path Parameters

Request Body

Example — By Unit IDs

{
  "unitIds": [
    "665b2c3d4e5f6a7b8c9d0e1f",
    "665b2c3d4e5f6a7b8c9d0e2a"
  ]
}

Example — By Unit Names

{
  "unitNames": ["1-Adam-12", "2-Boy-15"]
}

Close a 911 call with a disposition and optional closing notes.

Path Parameters

Request Body

Example Request

{
  "disposition": "Arrest Made",
  "notes": "Suspect apprehended at scene. One weapon recovered."
}

Get all active BOLOs for the dispatch dashboard. Returns non-expired, non-deactivated BOLOs.

Query Parameters

Response

[
  {
    "_id": "665d4e5f6a7b8c9d0e1f2a3b",
    "reason": "Armed Robbery Suspect",
    "description": "Suspect robbed a convenience store at gunpoint",
    "priority": "critical",
    "subjectFirstName": "John",
    "subjectLastName": "Doe",
    "subjectDescription": "Male, 6ft, black hoodie",
    "vehiclePlate": "XYZ9876",
    "vehicleMake": "Ford",
    "vehicleModel": "F-150",
    "vehicleColor": "Black",
    "isActive": true,
    "viewedBy": ["user1", "user2"],
    "expiresAt": "2025-06-02T14:00:00.000Z",
    "createdAt": "2025-06-01T14:00:00.000Z"
  }
]

Search BOLOs by text query. Searches across reason, description, subject name, and vehicle information.

Query Parameters

Create a new BOLO. Requires the boloPermission level configured for the community (admin, supervisor, or all).

Request Body

Subject Fields (all optional)

Vehicle Fields (all optional)

Example Request

{
  "reason": "Armed Robbery Suspect",
  "description": "Suspect robbed First National Bank, fled on foot heading east",
  "communityId": "663f1a2b3c4d5e6f7a8b9c0d",
  "priority": "critical",
  "subjectFirstName": "John",
  "subjectLastName": "Doe",
  "subjectDescription": "Male, 6ft, wearing black hoodie and jeans",
  "vehiclePlate": "XYZ9876",
  "vehicleMake": "Ford",
  "vehicleModel": "F-150",
  "vehicleYear": "2022",
  "vehicleColor": "Black",
  "vehicleDescription": "Lifted, tinted windows, aftermarket bumper",
  "expiresAt": "2025-06-02T14:00:00.000Z"
}

Update an existing BOLO. Accepts all the same fields as the create endpoint. Only provided fields will be modified.

Path Parameters

Example Request

{
  "priority": "high",
  "description": "Updated: suspect last seen heading west on Interstate 4",
  "vehicleDescription": "Damage to front-left quarter panel"
}

Deactivate a BOLO. The BOLO record is retained but marked as inactive and will no longer appear in active BOLO listings.

Path Parameters

Mark a BOLO as viewed by the current user. Used to track which officers have acknowledged and read a BOLO.

Path Parameters

Perform a smart search across civilians, vehicles, and records. The system automatically detects the query type, or you can specify it explicitly.

Request Body

Search Type Behavior

Example Request

{
  "query": "John Smith",
  "communityId": "663f1a2b3c4d5e6f7a8b9c0d",
  "type": "name"
}

Response

{
  "civilians": [
    {
      "_id": "665e5f6a7b8c9d0e1f2a3b4c",
      "firstName": "John",
      "lastName": "Smith",
      "dateOfBirth": "1990-05-15",
      "licenseNumber": "DL-12345",
      "phone": "555-0123",
      "address": "742 Evergreen Terrace"
    }
  ],
  "vehicles": [
    {
      "_id": "665f6a7b8c9d0e1f2a3b4c5d",
      "plate": "ABC1234",
      "make": "Honda",
      "model": "Civic",
      "year": "2020",
      "owner": "John Smith"
    }
  ]
}

Get recent lookup history. Useful for showing officers their most recent searches for quick re-access.

Query Parameters

Get detailed civilian information by record ID. Returns full profile including licenses, warrants, flags, and associated vehicles.

Path Parameters

Query Parameters

Get detailed vehicle information by record ID. Returns registration, owner details, stolen status, and insurance info.

Path Parameters

Query Parameters

Get all reports (incidents, citations, arrests) associated with a specific license number. Useful for pulling a subject's full history during a stop.

Path Parameters

Query Parameters

Response

{
  "reports": [
    {
      "_id": "665g7b8c9d0e1f2a3b4c5d6e",
      "type": "citation",
      "title": "Speeding - 85 in a 55 zone",
      "officerName": "Officer Adams",
      "createdAt": "2025-05-28T10:15:00.000Z"
    },
    {
      "_id": "665h8c9d0e1f2a3b4c5d6e7f",
      "type": "arrest",
      "title": "DUI - First Offense",
      "officerName": "Officer Baker",
      "createdAt": "2025-05-15T22:30:00.000Z"
    }
  ]
}

Create a new suspect record.

Example Request

{
  "firstName": "John",
  "lastName": "Doe",
  "description": "Male, 6ft, black hoodie",
  "status": "at-large",
  "communityId": "663f1a2b3c4d5e6f7a8b9c0d"
}

Get all suspect records for the community.

Response

[
  {
    "_id": "665i9d0e1f2a3b4c5d6e7f8a",
    "firstName": "John",
    "lastName": "Doe",
    "description": "Male, 6ft, black hoodie",
    "status": "at-large",
    "communityId": "663f1a2b3c4d5e6f7a8b9c0d",
    "createdAt": "2025-06-01T15:00:00.000Z"
  }
]

Get a single suspect record by ID with full details.

Path Parameters

Update an existing suspect record. Only provided fields will be modified.

Path Parameters

Example Request

{
  "status": "in-custody",
  "description": "Updated: suspect now in custody at Central Booking"
}

Get all active (non-expired) announcements for the dispatch dashboard.

Query Parameters

Response

[
  {
    "_id": "665j0e1f2a3b4c5d6e7f8a9b",
    "title": "Shift Change Reminder",
    "message": "All day-shift units report to briefing room at 1800 hours for shift change.",
    "priority": "info",
    "communityId": "663f1a2b3c4d5e6f7a8b9c0d",
    "expiresAt": "2025-06-01T18:00:00.000Z",
    "createdBy": "Sgt. Johnson",
    "createdAt": "2025-06-01T12:00:00.000Z"
  },
  {
    "_id": "665k1f2a3b4c5d6e7f8a9b0c",
    "title": "High-Speed Pursuit Policy Update",
    "message": "Effective immediately: all pursuits require supervisor authorization before initiation.",
    "priority": "urgent",
    "communityId": "663f1a2b3c4d5e6f7a8b9c0d",
    "expiresAt": null,
    "createdBy": "Chief Williams",
    "createdAt": "2025-06-01T08:00:00.000Z"
  }
]

Create a new announcement. Only users with supervisor or admin roles can create announcements.

Request Body

Priority Levels

Example Request

{
  "title": "Severe Weather Warning",
  "message": "Tornado warning in effect for the northern district until 2100 hours. All units exercise caution.",
  "priority": "warning",
  "communityId": "663f1a2b3c4d5e6f7a8b9c0d",
  "expiresAt": "2025-06-01T21:00:00.000Z"
}

Response 201

{
  "success": true,
  "announcement": {
    "_id": "665l2a3b4c5d6e7f8a9b0c1d",
    "title": "Severe Weather Warning",
    "message": "Tornado warning in effect for the northern district until 2100 hours. All units exercise caution.",
    "priority": "warning",
    "communityId": "663f1a2b3c4d5e6f7a8b9c0d",
    "expiresAt": "2025-06-01T21:00:00.000Z",
    "createdAt": "2025-06-01T15:30:00.000Z"
  }
}

Delete an announcement. Only users with supervisor or admin roles can delete announcements. The announcement is permanently removed.

Path Parameters