Form entity

Read dealership forms with ASC metadata, CRM delivery settings, submission recipients, and nested fields.

#Endpoints

Forms define the fields and routing metadata used by website lead-capture experiences.

GET/v1/forms

GET/v1/forms/{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.

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

Parameter	Type	Required	Notes
limit	number	No	Number of records to return. Defaults to `100`. Maximum is `500`.
offset	number	No	Number of records to skip. Defaults to `0`.
search	string	No	Optional text search. Searchable fields are listed on each entity.
createdAfter	datetime	No	Return records created at or after an ISO 8601 timestamp.
createdBefore	datetime	No	Return records created at or before an ISO 8601 timestamp.
updatedAfter	datetime	No	Return records updated at or after an ISO 8601 timestamp.
updatedBefore	datetime	No	Return records updated at or before an ISO 8601 timestamp.
service	string	No	Filter by exact form service identifier.

Entity filters

Common list filters plus service and search.

Search fields

name and service.

JSON

{
  "data": [],
  "pagination": {
    "limit": 100,
    "offset": 0,
    "total": 0
  }
}

Field	Type	Nullable	Notes
id	uuid	No	Form ID.
name	string	No	Form name.
service	string	No	Service/routing identifier.
sendToCRM	boolean	No	Whether submissions are sent to CRM.
ascType	ASCFormType	No	ASC form type.
ascDepartment	ASCDepartment	No	ASC department.
sendSubmissionsTo	string[]	No	Email recipients for submissions.
fields	FormField[]	No	Active form fields sorted by sortIndex.
createdAt	datetime	No	Creation timestamp.
updatedAt	datetime	No	Last update timestamp.

Fields

Includes id, name, service, sendToCRM, ascType, ascDepartment, sendSubmissionsTo, nested fields, createdAt, and updatedAt.

Shell

curl "https://api.driverseat.io/v1/forms?service=vehicle" \
  -H "x-api-key: sk-driverseat-..."

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 does not exist or does not belong to the dealership authorized by the API key.