> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sparkserv.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Sparkserv scheduling API

> Discover dealership services and availability, then book and manage service appointments.

Use the Sparkserv API to build a service scheduling integration for dealerships your API client can access. You can discover vehicle-specific services, find appointment times, and create, read, update, or cancel appointments.

Your integration calls Sparkserv from your server. Sparkserv connects scheduling requests to the dealership's configured scheduler.

## Start here

> **[Make your first request](https://docs.sparkserv.com/quickstart.md)**
>
> Get an access token and list the dealerships you can access.

> **[Book an appointment](https://docs.sparkserv.com/guides/book-an-appointment.md)**
>
> Discover services and availability, then submit a booking.

> **[Manage appointments](https://docs.sparkserv.com/guides/manage-appointments.md)**
>
> Read, search, update, and cancel appointments.

> **[Handle errors safely](https://docs.sparkserv.com/guides/errors-and-retries.md)**
>
> Handle stale availability and unconfirmed scheduling changes.

## How scheduling works

1. Authenticate and choose a dealership.
2. Discover its departments and services for the customer's vehicle.
3. Discover eligible advisors and transport options.
4. Search for available times using those selections.
5. Book a selected time and save the returned appointment ID.

The [API Reference](https://docs.sparkserv.com/api-reference/dealerships/list-the-dealerships-this-client-can-access.md) contains the generated endpoint documentation, request schemas, and response fields. The guides explain how to use those endpoints together.

## Key concepts

| Term | Meaning |
| - | - |
| Dealership | An authorized store, identified by a Spark UUID. Dealership-scoped requests use the `Dealership-Id` header. |
| Department | A scheduling department. Whether you can select one depends on the dealership's scheduler. |
| Service | A vehicle-specific service selection. Use the Spark service UUID returned by discovery. |
| Advisor and transport | Scheduling choices returned for your request. Treat their IDs as opaque values, not names or UUIDs you construct. |
| Appointment | A booking with a Spark UUID. Appointment reads return Spark's stored snapshot, not a live refresh from the scheduler. |

> [!WARNING]
>
> Availability is not a reservation, and service prices are estimates. Booking has no durable idempotency guarantee. If a write times out or its outcome is unknown, do not blindly retry it.

For credentials, dealership access, or integration questions, contact [support@sparkserv.com](mailto:support@sparkserv.com).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.