v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

List the form entries (v1)

get/v1/form_entries

Query parameters

dispatch_ids[]integer[]

Specify the dispatch IDs to narrow down the form entry results.

driver_ids[]integer[]

Specify the driver IDs for whom you want to fetch the form entries.

vehicle_ids[]integer[]

Specify the vehicle IDs for whom you want to fetch the form entries.

min_created_atstring date

Specify a date post which you want to fetch the form entries.

max_created_atstring date

Specify a date before which you want to fetch the created form entries.

per_pagestring

Number of records to return per page

page_nostring

Current page number

Response

200

Example response

{
  "form_entries": [
    {
      "form_entry": {
        "id": 95,
        "form_id": 943,
        "driver_id": 1136,
        "vehicle_id": 802,
        "dispatch_id": 137,
        "dispatch_stop_id": 231,
        "dispatch_trip_id": 13,
        "bearing": 73,
        "city": "San Diego",
        "created_at": "2023-04-20T14:29:04Z",
        "entered_at": "2023-04-20T14:29:04Z",
        "lat": 1,
        "lon": 2,
        "odometer": 547.427851,
        "rg_brg": 2,
        "rg_km": 3,
        "state": "CA",
        "stop_category": "additional_stop",
        "entry": {
          "name": "Bar"
        },
        "form_version": 1,
        "speed": 24.2,
        "location": "2 mi NW San Diego",
        "vendor_dispatch_id": "vv-1",
        "vendor_stop_id": "797a46"
      }
    }
  ],
  "pagination": {
    "per_page": 25,
    "page_no": 1,
    "total": 2
  }
}