Skip to main content

Response Overview Ep

POST 
/v1/forms/responses

Integration Form Response Overview

Returns form responses filled out by drivers during their shift.

Required Scopes (io.r)

Request​

form_name: str | None = None
The name of the form. If provided, filters responses for the specified form.

from_date: datetime
The starting date for the date range filter.

to_date: datetime
The ending date for the date range filter.

market: str | None = None
The market associated with the form responses. If provided, filters responses for the specified market.

note

If no filters are provided, all form responses within the default system range will be returned.


Response​

from_date: datetime
Starting date for the date range in the response.

to_date: datetime
Ending date for the date range in the response.

market: str | None = None
Market for the responses, if applicable.

responses: list[FormResponseRow]
List of form response rows matching the criteria.

Show Child Attributes

id: PydanticObjectId
Unique identifier for the form response.

name: str
Name of the form response.

description: str | None = None
Description of the form response.

order_number: int
Unique order number associated with the response.

driver_name: str
Name of the assigned driver.

date: datetime
Date of the form submission.

shift: str
Driver's shift during form submission.

location_name: str | None = None
Name of the location.

address: str | None = None
Address of the form submission location.

latitude: float | None = None
Latitude coordinate of the location.

longitude: float | None = None
Longitude coordinate of the location.

market: str | None = None
Market associated with the response.

sector: str | None = None
Sector within the market.

supply_zones: list[str] | None = []
List of supply zones covered by the response.

tractor: str | None = None
Tractor identifier for the response.

trailer_number: str | None = None
Trailer number associated with the response.

required: bool = False
Whether the form response was marked as required.

response: list[FormFieldResponse]
List of responses for each form field.

Responses​

Successful Response

[
  {
    "id": "5eb7cf5a86d9755df3a6c593",
    "name": "string",
    "description": "string",
    "order_number": 0,
    "driver_name": "string",
    "date": "2025-12-17T21:49:50.688Z",
    "shift": "string",
    "location_name": "string",
    "address": "string",
    "latitude": 0,
    "longitude": 0,
    "market": "string",
    "sector": "string",
    "supply_zones": [
      "string"
    ],
    "tractor": "string",
    "trailer_number": "string",
    "required": false,
    "response": [
      {
        "field_name": "string",
        "field_type": "number",
        "required": false
      }
    ]
  }
]
Loading...