Site entity

Read website settings for the authorized dealership, including inventory display, payment calculator, contact bar, lead form, and media settings.

#Endpoints

The site entity is the dealership website configuration used to interpret public URLs and website behavior.

GET/v1/site

Auth

Send the dealership API key in the x-api-key header.

Detail IDs

This entity is returned for the dealership authorized by the API key.

Dates

Date fields and date filters use ISO 8601 timestamps.

#Response

Field	Type	Nullable	Notes
id	uuid	No	Site ID.
domain	string	No	Configured custom domain.
subdomain	string	No	Driverseat subdomain.
publishedAt	datetime	Yes	Publication timestamp.
publicDomain	string	No	Domain used for public URLs.
inventory	object	No	Inventory display, filtering, tag, and pricing settings.
paymentCalculator	object	No	Payment calculator defaults.
leadFormConfig	json	No	Lead form configuration.
contactBar	object	No	Mobile contact bar settings.
globalMetaImage	File	Yes	Default meta image.
faviconImage	File	Yes	Favicon image.
vehicleOverlayImage	File	Yes	Vehicle overlay image.

Fields

Includes domain, subdomain, publishing state, publicDomain, CTA, inventory settings, payment calculator defaults, lead form configuration, contact bar settings, and site media.

#Example Request

Shell

curl "https://api.driverseat.io/v1/site" \
  -H "x-api-key: sk-driverseat-..."

#Errors

401

The API key is missing, invalid, or revoked.

404

The authorized dealership could not be found.