Skip to content
Menu
FOR OPERATORS & DEVELOPERS

Your website.
Connected to your roster.

Let passengers book through a ready-made form, or connect your own website to our company-scoped booking API. Both routes bring reservations into the same dispatch workspace.

01 / READY-MADE

Share or embed the form.

Choose a heading, message and button color. Control hourly rides, return trips, stops, contact requirements and advance notice. Copy your company’s link or HTML embed code from System → Public booking form.

See embed instructions →
02 / CUSTOM WEBSITE

Build with the API.

Keep your website’s booking experience. Your server uses a company-specific API key to request fare estimates, create reservations, and read the status of bookings created through the API.

Read the API guide →

Add a booking form to your website

  1. Sign in and select the company you want to connect.
  2. Open System → Public booking form, customize the form, and save.
  3. Copy the booking link for a button, or paste the embed code into your website’s HTML block.
<iframe
  src="https://liveryroster.com/book/YOUR-COMPANY-SLUG?embed=1"
  title="Book a ride" width="100%" height="1100"
  style="border:0;max-width:100%" loading="lazy"
  referrerpolicy="strict-origin-when-cross-origin">
</iframe>

Replace YOUR-COMPANY-SLUG with the link shown in your workspace. The iframe has its own scroll area; adjust the height to fit your page. No API key or passenger sign-in is required.

Prefill a trip

Supported URL parameters: pickup, dropoff, date (YYYY-MM-DD), time (HH:mm), state, vehicle, type (transfer or hourly), hours, pax, and flight. URL-encode values. Passenger contact details are entered in the form, rather than placed in a link.

const url = new URL(companyBookingUrl);
url.searchParams.set('pickup', 'Dulles International Airport, VA');
url.searchParams.set('pax', '2');
window.location.assign(url.toString());

Pausing public bookings blocks form submissions and fare requests, including existing embeds. API credentials are managed separately. Prices and pickup times use the company’s rate card and time zone.

Start with a company API key

An owner or company admin creates a key in System → Client API access. Give it a useful name, choose permissions and an expiry, and save the full key when it is displayed. Only a hash is stored.

Keep your key on your website server.

Use an environment variable such as LIVERY_ROSTER_API_KEY. Do not include it in HTML, browser JavaScript, mobile apps, URLs, or public repositories. Browser cross-origin API calls are rejected; use the embedded form when you do not have a backend.

curl https://liveryroster.com/api/v1/company \
  -H "Authorization: Bearer $LIVERY_ROSTER_API_KEY"

This read-only call checks your key and returns your company’s name, slug, time zone, allowed scopes and supported vehicle IDs. There is no separate sandbox endpoint: a successful booking POST creates a real reservation and may trigger configured notifications.

API endpoints

Method & pathPermissionPurpose
GET /api/v1/companyAny active keyCompany configuration and vehicle IDs
POST /api/v1/quotesquotes:readServer-calculated fare estimate
POST /api/v1/bookingsbookings:writeCreate one reservation
GET /api/v1/bookings/{id}bookings:readStatus of this company’s API booking

All endpoints require a Bearer key. Send JSON for POST requests. The OpenAPI 3.0 specification includes request fields, response shapes and errors for Postman or an API client generator.

Create a reservation

The following is an example payload. Replace the date, route, passenger and reference with your real booking data before use. Dates and times are interpreted in your company’s time zone; state is the two-letter US pickup state.

curl https://liveryroster.com/api/v1/bookings \
  -H "Authorization: Bearer $LIVERY_ROSTER_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: website-order-1042' \
  --data '{
  "type": "transfer",
  "vehicle": "sedan",
  "pickup": "Dulles International Airport, VA",
  "dropoff": "1600 Pennsylvania Avenue NW, Washington, DC",
  "date": "2030-10-15",
  "time": "14:30",
  "pax": 2,
  "name": "Example Passenger",
  "email": "passenger@example.com",
  "state": "VA",
  "reference": "website-order-1042"
}'

For a quote, send only trip fields to /api/v1/quotes: type, vehicle, pickup, dropoff, date, time, and optional pax, stops, childSeats and meetGreet. Hourly rides also require hours. The booking request adds name, phone or email, state, and optional city, luggage, flight, notes and reference.

A created booking returns HTTP 201 with booking.id, reservation reference, status, estimated fare and a passenger tracking URL. Keep the tracking link private. Website-supplied prices, payment status, company IDs and driver assignments are not accepted.

Retries without duplicate bookings

Send a unique Idempotency-Key for each reservation. If a request times out, retry with the same key and JSON values. A replay returns HTTP 200 and duplicate: true. Reusing the key with changed details returns HTTP 409. Protection remains while the reservation exists and works across key rotation. For a return leg, create a second request with its own key.

Limits, permissions and payment

  • 60 requests per minute per API key, shared across endpoints. HTTP 429 includes Retry-After: 60.
  • JSON request bodies are limited to 32 KB. API keys expire after 30, 90 or 365 days and can be revoked immediately.
  • Keys only access their own company. Booking status omits passenger contact details and internal staff data.
  • The API creates reservations with status new for dispatch. It does not automatically charge a card, assign a driver, cancel a ride or send outbound webhooks.
  • Fares are estimates calculated from the company’s rate card. Distance pricing may need dispatch confirmation when routing is unavailable.
  • Payments, SMS, email and mapping depend on the operator’s configured providers. Never send payment card details to this API.

Use HTTP 401 to detect expired or revoked keys, 403 for insufficient permissions, 404 for unknown bookings, and 400 for invalid input. The current API supports one-way and hourly reservations with US pickup states. Custom website development and provider charges are scoped separately.

Ready to connect your operation?

Start with the form, or give your developer a scoped API key and this guide.