API - Locations - Retrieve List or Location Data | API

Retrieve a paged list of the locations in your account, or the details of one specific location.

Action	Method	URL	Package
List locations	`GET`	`https://rental.software/api6/locations`	WP/API and Multi-Location
Details of one location	`GET`	`https://rental.software/api6/locations/{location_id}`	WP/API and Multi-Location

Prerequisites

An active API key created under Settings > API Keys. Include it as ?apiKey=YOUR_API_KEY on the request URL. See API - Setup Access.
The API key must have access to each location that you want it to return.
When creating a key, it is recommended to restrict allowed IP addresses to the servers that will make the calls (optional but recommended).

Single location account? Starting with the October 2026 release, these two endpoints require the Multi-Location package. See API - Packages and Endpoint Access.

Step-by-Step Instructions

Generate or copy an API key from Settings > API Keys.
Build a GET request to the locations endpoint and include your API key plus any paging values:
```
GET https://rental.software/api6/locations/?apiKey=YOUR_API_KEY&offset=0&limit=25
```

Send the request (example using curl):

curl "https://rental.software/api6/locations/?apiKey=YOUR_API_KEY&offset=0&limit=25" -H "Accept: application/json"

Inspect the JSON response for the items array containing the location records (id, href, name).

To get the details of one location, add its id to the URL:

GET https://rental.software/api6/locations/6705?apiKey=YOUR_API_KEY

Parameters

Parameter	Default	Description
`apiKey`		Required. Your API key
`location_id`		Optional, in the URL path. ID of a known location in your account, to get details about that location
`offset`	`0`	Start record number for paging
`limit`	`25`	Number of records to return
`_body`	`false`	If `true`, the list returns the full details of each location instead of only its ID and name

Response (Example)

{
  "offset": 0,
  "limit": 25,
  "first": "https://rental.software/api6/locations_list?offset=0&limit=25",
  "next": "https://rental.software/api6/locations_list?offset=25&limit=25",
  "previous": "https://rental.software/api6/locations_list?offset=0&limit=25",
  "items": [
    {
      "id": "6705",
      "href": "https://rental.software/api6/locations/6705",
      "name": "Akron"
    },
    {
      "id": "6707",
      "href": "https://rental.software/api6/locations/6707",
      "name": "Cleveland"
    }
  ],
  "request_time": 1758223748
}

Returned Fields

Field	Description
`offset`, `limit`	Paging values
`first`, `next`, `previous`	Paging URLs. Add your API key before calling one
`items`	Array of location objects: `id`, `href` (the location's own API URL) and `name`

Use the location id wherever another API call asks for a locationid or location_id, for example when creating a lead in a specific location.

Troubleshooting & FAQs

What you see	What it means	What to do
`401` "No API Key provided"	The request has no `apiKey`	Add `?apiKey=YOUR_API_KEY` to the URL
`404` "No locations found"	The list is empty at that offset, or the key has no access to any location	Check the locations the API key can access, or page back to an earlier `offset`
`404` "Item not found"	No location with that ID exists in your account	Check the `location_id` in the URL
`405` "Only accepts GET requests"	The endpoint is read only	Use GET
`429` "Too Many Requests"	You exceeded a rate limit	Wait, then retry less often. See API - Errors and Rate Limits

API - Locations - Retrieve List or Location Data