Page entity

Read website page records, publishing state, routing metadata, SEO fields, creators, collaborators, images, and public URLs.

#Endpoints

Website page records for the dealership site. Pages include SEO fields, publishing state, routing metadata, public URL, linked vehicle or blog post summaries, page props, creator, collaborators, and image references.

GET/v1/pages

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

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.
state	PageState	No	`DRAFTPUBLISHEDARCHIVED`
kind	PageKind	No	`STANDARDCOLLECTIONDETAIL`
surface	PageSurface	No	`STANDARDINVENTORYVEHICLEPOST`

Entity filters

Common list filters plus state, kind, surface, and search.

Search fields

title, slug, description, and metaTitle.

Archived behavior

Archived pages are excluded by default. Pass state=ARCHIVED to request them.

Default sort

lastEditedAt descending, then id descending.

PageState

DRAFTPUBLISHEDARCHIVED

PageKind

STANDARDCOLLECTIONDETAIL

PageSurface

STANDARDINVENTORYVEHICLEPOST

ASCPageType

ITEMITEMLISTCONTACTDIRECTIONSSERVICEPARTSACCESSORIESBODY_SHOPHOMEBUILD_TO_ORDERCUSTOMCOMPLAINTEMPLOYMENTRECALLFINANCECREDITTRADECOMMERCIALSHOWROOM

JSON

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

#Response

Field	Type	Nullable	Notes
id	uuid	No	Page ID.
siteId	uuid	No	Website/site ID for the dealership.
title	string	No	Page title.
slug	string	No	Path or internal template slug.
state	PageState	No	`DRAFTPUBLISHEDARCHIVED`
ascType	ASCPageType	No	Automotive Standards Council page type.
kind	PageKind	No	`STANDARDCOLLECTIONDETAIL`
surface	PageSurface	No	`STANDARDINVENTORYVEHICLEPOST`
description	string	Yes	SEO/social description.
metaTitle	string	Yes	SEO title override.
metaTitleIsAbsolute	boolean	No	Whether the meta title replaces the default title template.
shouldIndex	boolean	No	Whether the page should be indexed.
previousSlugs	string[]	No	Previous public paths.
templatePageId	uuid	Yes	Template page source when applicable.
vehicle	VehicleSummary	Yes	Linked vehicle for vehicle detail pages.
post	BlogPostSummary	Yes	Linked blog post for post detail pages.
props	json	Yes	Page props. Page-builder row internals are not included.
createdBy	User	No	User who created the page.
collaborators	User[]	No	Users attached as collaborators.
metaImage	File	Yes	SEO/social image metadata.
previewImage	File	Yes	Preview image metadata.
publicUrl	url	Yes	Public URL. Internal template pages can be null.
publishedAt	datetime	Yes	Publication timestamp.
lastEditedAt	datetime	No	Last editor-visible update timestamp.
createdAt	datetime	No	Creation timestamp.
updatedAt	datetime	No	Last update timestamp.

Identity

id, siteId, title, slug, state, kind, surface, and ascType.

SEO

description, metaTitle, metaTitleIsAbsolute, shouldIndex, metaImage, and previewImage.

Routing

publicUrl, previousSlugs, templatePageId, matchRules, templatePriority, and inheritTemplateRows.

Relationships

Optional vehicle and post summaries, plus createdBy and collaborators.

Dates

publishedAt, lastEditedAt, createdAt, and updatedAt ISO 8601 timestamps.

Page responses include page props, but not page-builder row internals. Internal template pages can have a null publicUrl.

#Example Request

Shell

curl "https://api.driverseat.io/v1/pages?state=PUBLISHED&surface=STANDARD" \
  -H "x-api-key: sk-driverseat-..."

#Example Response

JSON

{
  "data": [
    {
      "id": "page-id",
      "siteId": "site-id",
      "title": "Finance Center",
      "slug": "/finance",
      "state": "PUBLISHED",
      "kind": "STANDARD",
      "surface": "STANDARD",
      "publicUrl": "https://example-dealer.com/finance",
      "createdBy": {
        "id": "user-id",
        "name": "Jane Editor",
        "email": "jane@example.com"
      },
      "lastEditedAt": "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 page does not exist or does not belong to the dealership authorized by the API key.