Skip to content
API reference
/
/
Archive vehicles (bulk) —...

Overview

The AutoLeap API uses the REST standard, which means you interact with it by making requests over HTTP.

A request usually includes:

  • An HTTP method (like GET or POST)
  • A path (the address of the resource)
  • Optional headers and parameters (in the path, query string, or request body)

When you send a request, the API responds with:

  • A status code (to indicate success or failure)
  • Response headers
  • Sometimes a response body with useful data

The API reference describes the method, path, and parameters for each endpoint, and includes sample requests and responses you can use as a guide.

Languages
Servers
Production
https://partnerapi.myautoleap.com/v2/

Authentication

Authenticate with the AutoLeap Partner API to obtain access tokens.
All other endpoints require a valid access token.

Operations

Profile

Retrieve partner profile details, including the companies and accounts you are authorized to access.

Operations

Customers

Retrieve and manage customer records for a given company.
Useful for syncing customer information across systems.

Operations

Vehicles

Retrieve and manage vehicles associated with customers.
Supports bulk creation and individual vehicle lookups.

Operations

BetaCreate vehicle(s)

Request

Creates one or more vehicles for the specified customer.
Supports bulk creation.

Security
BearerAuth
Bodyapplication/jsonrequired
companyIdstringrequired
Example: "SHOP5678"
vehiclesArray of objectsrequired
Example: [{"customerId":"CUST001","year":2021,"make":"Honda","model":"Accord","vehicleName":"2021 Honda Accord LX","engine":"1.5L Turbo I4","color":"Blue","licensePlate":"XYZ-1234","state":"CA","vin":"1HGCV1F14MA123456","imgUrl":"","notes":"Regular maintenance required","tags":[{"name":"Sedan","color":"FFFF00"},{"name":"Economy","color":"FFFF00"}],"driveType":"FWD","transmission":"Automatic","mileage":15000,"mileageUnit":"Miles"}]
vehicles[].​customerIdstring
vehicles[].​yearinteger
vehicles[].​makestring
vehicles[].​modelstring
vehicles[].​vehicleNamestring
vehicles[].​enginestring
vehicles[].​colorstring
vehicles[].​licensePlatestring
vehicles[].​statestring
vehicles[].​vinstring
vehicles[].​notesstring
vehicles[].​vehicleStatusstring
vehicles[].​imgUrlstring
vehicles[].​transmissionstring
Enum"Automatic""Manual"
vehicles[].​tagsArray of objects(Tag)
Example: [{"name":"VIP","color":"FFFF00"}]
vehicles[].​driveTypestring
vehicles[].​mileagenumber
vehicles[].​mileageUnitstring
Enum"KM""Miles"
curl -i -X POST \
  https://partnerapi.myautoleap.com/v2/vehicles \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "companyId": "SHOP5678",
    "vehicles": [
      {
        "customerId": "CUST001",
        "year": 2021,
        "make": "Honda",
        "model": "Accord",
        "vehicleName": "2021 Honda Accord LX",
        "engine": "1.5L Turbo I4",
        "color": "Blue",
        "licensePlate": "XYZ-1234",
        "state": "CA",
        "vin": "1HGCV1F14MA123456",
        "imgUrl": "",
        "notes": "Regular maintenance required",
        "tags": [
          {
            "name": "Sedan",
            "color": "FFFF00"
          },
          {
            "name": "Economy",
            "color": "FFFF00"
          }
        ],
        "driveType": "FWD",
        "transmission": "Automatic",
        "mileage": 15000,
        "mileageUnit": "Miles"
      }
    ]
  }'

Responses

Vehicle creation processed

Bodyapplication/json
successboolean
Example: true
messagestring
Example: "Request completed successfully"
dataobject
Example: {}
Response
application/json
{
  "success": true,
  "message": "Request completed successfully",
  "data": {}
}

Get vehicles (list or filtered)

Request

Security
BearerAuth
Query
companyIdstring
customerIdstring
searchstring
updatedDateStartstring(date-time)
updatedDateEndstring(date-time)
sortstring
sortDirectionstring
Enum"ASC""DESC"
sizeinteger
Default 100
pageinteger
Default 1
curl -i -X GET \
  'https://partnerapi.myautoleap.com/v2/vehicles?companyId=string&customerId=string&search=string&updatedDateStart=2019-08-24T14%3A15%3A22Z&updatedDateEnd=2019-08-24T14%3A15%3A22Z&sort=string&sortDirection=ASC&size=100&page=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Vehicles list

Bodyapplication/json
messagestring
resultsobject
Response
application/json
{
  "message": "Vehicle fetched successfully",
  "results": {
    "content": [ … ],
    "pagination": { … }
  }
}

BetaUpdate vehicles (bulk)

Request

Security
BearerAuth
Bodyapplication/jsonrequired
companyIdstringrequired
Example: "SHOP5678"
vehiclesArray of objectsrequired
Example: [{"vehicleId":"125838","notes":"Customer requested routine maintenance and oil change reminder","mileageUnit":"KM"},{"vehicleId":"374849","transmission":"Manual"}]
vehicles[].​vehicleIdstring
vehicles[].​yearinteger
vehicles[].​makestring
vehicles[].​modelstring
vehicles[].​vehicleNamestring
vehicles[].​enginestring
vehicles[].​colorstring
vehicles[].​licensePlatestring
vehicles[].​statestring
vehicles[].​vinstring
vehicles[].​notesstring
vehicles[].​vehicleStatusstring
vehicles[].​imgUrlstring
vehicles[].​transmissionstring
Enum"Automatic""Manual"
vehicles[].​tagsArray of objects(Tag)
Example: [{"name":"VIP","color":"FFFF00"}]
vehicles[].​driveTypestring
vehicles[].​mileagenumber
vehicles[].​mileageUnitstring
Enum"KM""Miles"
curl -i -X PUT \
  https://partnerapi.myautoleap.com/v2/vehicles \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "companyId": "SHOP5678",
    "vehicles": [
      {
        "vehicleId": "125838",
        "notes": "Customer requested routine maintenance and oil change reminder",
        "mileageUnit": "KM"
      },
      {
        "vehicleId": "374849",
        "transmission": "Manual"
      }
    ]
  }'

Responses

Update result

Bodyapplication/json
successboolean
Example: true
messagestring
Example: "Request completed successfully"
dataobject
Example: {}
Response
application/json
{
  "success": true,
  "message": "Request completed successfully",
  "data": {}
}

Archive vehicles (bulk) — sets vehicleStatus to Inactive

Request

Security
BearerAuth
Bodyapplication/jsonrequired
companyIdstring
vehiclesArray of objects
curl -i -X PATCH \
  https://partnerapi.myautoleap.com/v2/vehicles \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "companyId": "string",
    "vehicles": [
      {
        "vehicleId": "string",
        "customerId": "string"
      }
    ]
  }'

Responses

Archive result

Bodyapplication/json
successboolean
Example: true
messagestring
Example: "Request completed successfully"
dataobject
Example: {}
Response
application/json
{
  "success": true,
  "message": "Request completed successfully",
  "data": {}
}

Get vehicle by id

Request

Security
BearerAuth
Path
vehicleIdstringrequired
curl -i -X GET \
  'https://partnerapi.myautoleap.com/v2/vehicles/{vehicleId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Vehicle

Bodyapplication/json
messagestring
resultsobject
Response
application/json
{
  "message": "string",
  "results": {
    "content": [ … ],
    "pagination": { … }
  }
}

Items

Access and manage items (parts, tires, labor, etc.) available within a company.
Includes bulk creation and detailed item retrieval.

Operations

Inventory Levels

View and update inventory levels for items across one or more locations.

Operations

Item Pricing

Retrieve and update pricing information for items.
Useful for keeping partner systems in sync with AutoLeap’s catalog pricing.

Operations

Appointments

Create and retrieve customer appointment requests across locations.
Enables seamless scheduling and booking integrations.

Operations

Repair Orders

Retrieve detailed information about repair orders (ROs).
Supports fetching all orders or a specific order by RO number.

Operations

Payments

Access payment details linked to repair orders.
Useful for reconciling transactions and financial reporting.

Operations

Technician Timesheets

Retrieve detailed timesheet logs for technicians within a company and an optional location, filtered by a date range.

Operations