The HQ Rental Software API gives your systems the same data your team works with in HQ: reservations, vehicles, vehicle classes, locations, rates, customers, payments, invoices and more.
This page takes you from zero to your first successful request.1. Check that your plan includes API access#
API access is included in the PRO and Enterprise plans.
Without it, the Custom Integration Kit card in Settings shows "API access is only available on the PRO plan".2. Get your credentials#
Every request carries one value, the encoded API token.
It identifies your HQ account and the HQ user your integration acts as.To create a dedicated user for your integration (recommended):1.
Sign in to HQ as an administrator.
2.
Go to Settings > Integrations.
3.
On the Custom Integration Kit card, click Create Integration User and confirm.
the encoded API token, ready to use,
a Postman collection with ready-made requests.
3. Find your base URL#
Your base URL depends on the region that hosts your HQ account, which you can tell from the web address you use to sign in to HQ.
See Base URLs, regions and versioning for the list of regions and their web addresses.4. Make your first request#
Start with a read-only call, for example the list of your locations.
Replace the base URL and the token with your own values.A successful call returns your active locations (each location has more fields than shown here):{
"fleets_locations": [
{ "id": 1, "name": "Miami Airport", "brand_id": 1 }
]
}
"success": false, read Errors: some errors are returned with HTTP status 200.5. Next steps#
Authentication explains the token and what the integration user can do.
Errors and Responses and pagination describe what to expect from every endpoint.
Webhooks explains how HQ can notify your system when records change.
Modified at 2026-10-29 13:56:40
