Lead entity
Read dealership lead records, contact information, inquiry counts, and latest inquiry summaries.
#Endpoints
A lead is the customer identity record for a dealership. Inquiries point back to leads.
GET/v1/leads
GET/v1/leads/{id}
x-api-key header.#Filters and Limits
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. |
search.name, email, and phoneNumber.createdAt descending, then id descending.JSON
{
"data": [],
"pagination": {
"limit": 100,
"offset": 0,
"total": 0
}
}#Response
| Field | Type | Nullable | Notes |
|---|---|---|---|
| id | uuid | No | Lead ID. |
| dealershipId | uuid | No | Dealership that owns the lead. |
| name | string | No | Lead name. |
| string | No | Lead email address. | |
| phoneNumber | string | Yes | Lead phone number. |
| inquiryCount | number | No | Number of inquiries attached to this lead. |
| latestInquiry | InquirySummary | Yes | Most recent inquiry summary. |
| createdAt | datetime | No | Creation timestamp. |
| updatedAt | datetime | No | Last update timestamp. |
id and dealershipId.name, email, and nullable phoneNumber.inquiryCount and nullable latestInquiry with type, market status, service, provider, and created date.createdAt and updatedAt ISO 8601 timestamps.#Example Request
Shell
curl "https://api.driverseat.io/v1/leads?search=jane&limit=50" \
-H "x-api-key: sk-driverseat-..."#Example Response
JSON
{
"data": [
{
"id": "lead-id",
"dealershipId": "dealership-id",
"name": "Jane Driver",
"email": "jane@example.com",
"phoneNumber": "5551234567",
"inquiryCount": 2,
"latestInquiry": {
"id": "inquiry-id",
"type": "SALES",
"marketStatus": "IN_MARKET",
"service": "vehicle",
"provider": "driverseat.io",
"createdAt": "2026-06-24T12:00:00.000Z"
},
"createdAt": "2026-06-24T12:00:00.000Z",
"updatedAt": "2026-06-24T12:00:00.000Z"
}
],
"pagination": {
"limit": 50,
"offset": 0,
"total": 1
}
}