Dealership APIInquiry

Inquiry entity

Read customer inquiry records, lead and vehicle summaries, market status, service routing, employees, forms, and trade-in references.

#Endpoints

An inquiry is a customer interaction submitted through the website, usually attached to a lead and sometimes attached to a vehicle, form, employee, or trade-in.

GET/v1/inquiries
GET/v1/inquiries/{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.
typeInquiryTypeNoGENERALSALESSERVICETRADE_IN
marketStatusInquiryMarketStatusNoUNKNOWNIN_MARKETOUT_OF_MARKET
servicestringNoString service or form identifier. Values depend on dealership forms and lead routing.
Entity filters
Common list filters plus type, marketStatus, service, and search.
Search fields
Lead name, email, phoneNumber, vehicle vin, vehicle stockNumber, and comments.
service
String service or form identifier. Values depend on the dealership's forms and lead routing setup.
Default sort
createdAt descending, then id descending.
InquiryType
GENERALSALESSERVICETRADE_IN
InquiryMarketStatus
UNKNOWNIN_MARKETOUT_OF_MARKET
JSON
{
  "data": [],
  "pagination": {
    "limit": 100,
    "offset": 0,
    "total": 0
  }
}

#Response

FieldTypeNullableNotes
iduuidNoInquiry ID.
typeInquiryTypeNoGENERALSALESSERVICETRADE_IN
marketStatusInquiryMarketStatusNoUNKNOWNIN_MARKETOUT_OF_MARKET
servicestringNoService/form routing identifier.
providerstringNoProvider that created the inquiry.
commentsstringYesCustomer message or submitted comments.
tradeInConditionstringYesSubmitted trade-in condition.
tradeInIduuidYesAssociated trade-in record ID.
leadLeadSummaryNoCustomer identity summary.
vehicleVehicleSummaryYesVehicle summary when the inquiry is vehicle-specific.
siteSiteSummaryNoWebsite summary.
formFormSummaryYesForm metadata when submitted through a managed form.
employeeEmployeeSummaryYesAssigned employee.
preferredEmployeeEmployeeSummaryYesCustomer-preferred employee.
createdAtdatetimeNoCreation timestamp.
updatedAtdatetimeNoLast update timestamp.
Identity
id, type, marketStatus, service, and provider.
Customer
lead summary with ID, name, email, and phone number.
Context
Optional vehicle, site, form, employee, and preferredEmployee summaries.
Trade-in
tradeInId and tradeInCondition when present.
Dates
createdAt and updatedAt ISO 8601 timestamps.

#Example Request

Shell
curl "https://api.driverseat.io/v1/inquiries?type=SALES&marketStatus=IN_MARKET" \
  -H "x-api-key: sk-driverseat-..."

#Example Response

JSON
{
  "data": [
    {
      "id": "inquiry-id",
      "type": "SALES",
      "marketStatus": "IN_MARKET",
      "service": "vehicle",
      "provider": "driverseat.io",
      "lead": {
        "id": "lead-id",
        "name": "Jane Driver",
        "email": "jane@example.com"
      },
      "vehicle": {
        "id": "vehicle-id",
        "vin": "1FTFW1E50PFA00000",
        "stockNumber": "F1000"
      },
      "createdAt": "2026-06-24T12:00:00.000Z"
    }
  ],
  "pagination": {
    "limit": 100,
    "offset": 0,
    "total": 1
  }
}

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