Dealership entity
Read metadata for the dealership authorized by the API key, including site, logo, social, and color data.
#Endpoints
Dealership metadata for the API key owner, including basic site context used to interpret public URLs and website records.
GET/v1/dealership
x-api-key header.#Response
| Field | Type | Nullable | Notes |
|---|---|---|---|
| id | uuid | No | Dealership ID authorized by the API key. |
| name | string | No | Dealership display name. |
| nickname | string | Yes | Optional short display name. |
| slug | string | No | Internal dealership slug. |
| make | string | No | Primary franchise/make. |
| timezone | string | No | IANA timezone name. |
| description | string | Yes | Dealership description. |
| publicDomain | string | No | Domain used when building public URLs. |
| site | Site | No | Primary website metadata. |
| logoImage | File | Yes | Dealership logo metadata. |
| social | object | No | Facebook, Twitter/X, Instagram, YouTube, and LinkedIn URLs. |
| colors | object | No | Primary and accent brand color values. |
| createdAt | datetime | No | Creation timestamp. |
| updatedAt | datetime | No | Last update timestamp. |
id, name, nickname, slug, make, timezone, and description.publicDomain and a site object with domain, subdomain, CTA, title divider, default lead form description, vehicles per page, and site image references.logoImage, globalMetaImage, faviconImage, and vehicleOverlayImage use the shared file summary shape.social URLs and colors.primary / colors.accent.createdAt and updatedAt ISO 8601 timestamps.#Example Request
Shell
curl "https://api.driverseat.io/v1/dealership" \
-H "x-api-key: sk-driverseat-..."#Example Response
JSON
{
"data": {
"id": "dealership-id",
"name": "Example Motors",
"slug": "example-motors",
"make": "Ford",
"timezone": "America/New_York",
"publicDomain": "example-dealer.com",
"site": {
"id": "site-id",
"domain": "example-dealer.com",
"subdomain": "example",
"publishedAt": "2026-06-24T12:00:00.000Z"
},
"colors": {
"primary": "#0f172a",
"accent": "#2563eb"
}
}
}