API Reference

Last Updated:

These reference pages introduce the API specs that are available in Fortellis. The pages range from broad API descriptions for browsing to detailed information for coding with individual API endpoints (methods). The Try It Out feature lets you run test calls on the API endpoints to see sample calls, parameters, and responses.

Domain Pages

Fortellis APIs are grouped by their domain in the automotive business. Domains cover front office functions (Sales) to fixed ops (Service).

Each domain page lists the domain's API specs with a link to each API and a description of how the API fits in the overall workflow. This is a great place to start browsing for APIs to use in your solution.

API Pages

Each API has its own page with a list of all the methods in the API, grouped into categories. This page serves two purposes. It gives you a more detailed look at what you can do with the API, and it is how you access detailed information for the API endpoints.

Each name in the endpoint list is a link to the API Spec page for that endpoint.

Query Appointments

Queries booked appointments

Cancel Appointment

Cancels an appointment

API Spec Pages

The API Spec page is your source for the details you need for an endpoint in a Fortellis API. Most of the information comes directly from the API spec. Look here for:

  • Resource URL
  • Data model (for POST and other payload methods)
  • Header and query parameters
  • Sample call: request, response, and cURL
  • HTTP error responses