Dealership APIForm Submission

Form Submission entity

Read submitted form records with the source form, backup JSON, and nested submitted field values.

#Endpoints

Form submissions are customer-submitted records for dealership forms. Submitted field values are nested with their form field metadata.

GET/v1/form-submissions
GET/v1/form-submissions/{id}
Auth
Send the dealership API key in the x-api-key header.
Detail IDs
Detail routes use the UUID returned by the corresponding list endpoint.
Dates
Date fields and date filters use ISO 8601 timestamps.

#Filters and Limits

List endpoints share the same pagination envelope. Query booleans use true or false.

ParameterTypeRequiredNotes
limitnumberNoNumber of records to return. Defaults to 100. Maximum is 500.
offsetnumberNoNumber of records to skip. Defaults to 0.
searchstringNoOptional text search. Searchable fields are listed on each entity.
createdAfterdatetimeNoReturn records created at or after an ISO 8601 timestamp.
createdBeforedatetimeNoReturn records created at or before an ISO 8601 timestamp.
updatedAfterdatetimeNoReturn records updated at or after an ISO 8601 timestamp.
updatedBeforedatetimeNoReturn records updated at or before an ISO 8601 timestamp.
formIduuidNoFilter by source form ID.
Entity filters
Common list filters plus formId and search.
Search fields
Source form name and service.
Default sort
createdAt descending, then id descending.
JSON
{
  "data": [],
  "pagination": {
    "limit": 100,
    "offset": 0,
    "total": 0
  }
}

#Response

FieldTypeNullableNotes
iduuidNoForm submission ID.
formFormSummaryNoSource form summary.
backupjsonYesBackup submission payload.
fieldsFormSubmissionField[]NoSubmitted field values with field metadata.
createdAtdatetimeNoCreation timestamp.
updatedAtdatetimeNoLast update timestamp.
Fields
Includes id, form summary, backup JSON, nested submitted field values, createdAt, and updatedAt.

#Example Request

Shell
curl "https://api.driverseat.io/v1/form-submissions?formId=form-id" \
  -H "x-api-key: sk-driverseat-..."

#Errors

400
Invalid query parameter or resource ID. Common causes include a limit above 500, an invalid UUID, an invalid datetime, or an unsupported enum value.
401
The API key is missing, invalid, or revoked.
404
The requested form submission does not exist or does not belong to the dealership authorized by the API key.