Get a simple availability overview for one day: every rental item with how many are rented and how many are still available on that date. Use it to show a "what is available on this day" view.
| Method | URL | API key permission | Package |
|---|---|---|---|
| GET | https://rental.software/api6/availability_list | Settings Rental Inventory: Read Only or Full Access | WP/API |
Which availability endpoint should I use? This one looks at a whole day and is good for an overview. To check specific start and end times, to check several dates in one call, or to get prices, use API - Availability & Pricing API Endpoint.
Request
GET /api6/availability_list?apiKey=YOUR_API_KEY&date=7/25/2026&cat=34
| Parameter | Required | Description |
|---|---|---|
| apiKey | Yes | Your API key |
| date | Yes | The day to check, in the date format of your account. Send it as MM/DD/YYYY unless your account is set as DD/MM/YYYY |
| cat | No | A category ID. Only items in that category are returned. Leave it out to get all items. Get category IDs from API - Categories - Retrieve List |
Example using curl:
curl "https://rental.software/api6/availability_list?apiKey=YOUR_API_KEY&date=7/25/2026&cat=34"
Response
{
"items": [
{
"id": "30083",
"ridename": "Themed Bounce House",
"imageloc": "https://rental.software/users/images/example-bounce-house.jpg",
"imagelocbig": "",
"rented": "1",
"available": 1
},
{
"id": "336198",
"ridename": "10x10 Tent",
"imageloc": "https://rental.software/users/images/example-tent-small.jpg",
"imagelocbig": "https://rental.software/users/images/example-tent-large.jpg",
"rented": 0,
"available": 12
}
],
"request_time": 1760000000
}Returned Fields
| Field | Description |
|---|---|
| id, ridename | Rental ID and name of the item |
| imageloc, imagelocbig | URLs of the small and large item image |
| rented | How many of the item are rented on that day |
| available | How many of the item are left on that day. Items out for repair are subtracted. A negative number means the item is overbooked |
Good to Know
- The whole day is checked, from midnight to midnight in your account's time zone. An item that is rented for only part of the day still counts as rented.
- All items are returned in one response. There is no paging.
- When nothing matches, the call still returns HTTP 200. The items array then holds a single entry with the ridename "No items to display", so check for that before you loop over the items.
Errors
| Status | Message | What to do |
|---|---|---|
| 405 | Only accepts GET requests | Use GET |
See API - Errors and Rate Limits for errors that apply to every call.