List the form entries (v1)

Purpose: Motive provides multiple forms to collect and record data for various operational tasks. These forms mostly pertain to driver, vehicle, and to meet compliance norms. You can fetch the forms to view the data collected for your reporting purposes, or just to understand about the business metrics.

📘

NOTE

A single API call will fetch a maximum of 3 months of data.

Response Parameters

form_entries

  • Type: Array of Objects
  • Description: List of form entries associated with the dispatch.

id

  • Type: Integer
  • Description: Unique identifier for the form entry.

form_id

  • Type: Integer
  • Description: ID of the form associated with the entry.

driver_id

  • Type: Integer
  • Description: ID of the driver who completed the form entry.

vehicle_id

  • Type: Integer
  • Description: ID of the vehicle associated with the form entry.

dispatch_id

  • Type: Integer
  • Description: ID of the dispatch associated with the form entry.

dispatch_stop_id

  • Type: Integer
  • Description: ID of the specific stop within the dispatch associated with the form entry.

dispatch_trip_id

  • Type: Integer
  • Description: ID of the dispatch trip associated with the form entry.

bearing

  • Type: Integer
  • Description: Bearing direction of the vehicle at the time of the entry.

city

  • Type: String
  • Description: City where the form entry was made (e.g., "San Diego").

created_at

  • Type: String (Date-Time)
  • Description: Timestamp when the form entry was created.

entered_at

  • Type: String (Date-Time)
  • Description: Timestamp when the form entry was made.

lat

  • Type: Integer
  • Description: Latitude coordinate of the form entry location.

lon

  • Type: Integer
  • Description: Longitude coordinate of the form entry location.

odometer

  • Type: Float
  • Description: Odometer reading at the time of the entry.

rg_brg

  • Type: Integer
  • Description: Registration bearing.

rg_km

  • Type: Integer
  • Description: Registration kilometers.

rg_match

  • Type: Boolean
  • Description: Indicates if the registration matches (e.g., false).

state

  • Type: String
  • Description: State where the form entry was made (e.g., "CA").

stop_category

  • Type: String
  • Description: Category of the stop (e.g., "additional_stop").

current_load_number

  • Type: String
  • Description: Current load number associated with the form entry.

entry

  • Type: Object

  • Description: The data entered in the form.

name

  • Type: String
  • Description: The name entered in the form (e.g., "Bar").

form_version

  • Type: Integer
  • Description: Version of the form used for the entry.

speed

  • Type: Float
  • Description: Speed of the vehicle at the time of the entry.

location

  • Type: String
  • Description: Description of the location (e.g., "2 mi NW San Diego").

vendor_dispatch_id

  • Type: String
  • Description: Vendor's dispatch ID.

vendor_stop_id

  • Type: String
  • Description: Vendor's stop ID.

Query Params
dispatch_ids[]
array of int32s

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

dispatch_ids[]
driver_ids[]
array of int32s

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

driver_ids[]
vehicle_ids[]
array of int32s

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

vehicle_ids[]
date

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

date

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

string
Defaults to 25

Number of records to return per page

string
Defaults to 1

Current page number

Response

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json