Skip to main content
POST
Find available appointment times

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Dealership-Id
string<uuid>
required

Body

application/json
vehicle
object
required

Identify the vehicle by VIN or by year, make and model. VIN may be enriched with partial details.

serviceIds
string<uuid>[]
required

Spark service UUIDs from service discovery

Minimum array length: 1
departmentId
string

An opaque department ID from department discovery

customer
object

Required during discovery only when the scheduler needs customer identity

startDate
string<date>

First inclusive dealership-local date; defaults to today

endDate
string<date>

Last inclusive dealership-local date; at most seven dates per request

advisorId
string

Opaque advisor ID, or any; omitted means any eligible advisor

transportId
string

Opaque transport ID from transport discovery; omitted selects a safe drop-off default

Response

timezone
string
required
Example:

"America/New_York"

vehicle
object
required
department
object | null
required
transport
object
required
items
object[]
required