API - Locations -Retrieve List or Location Data

Retrieve a paged list of locations for your account or details for a specific location. 

Prerequisites

• An active API token (apiKey) created under Settings → API Keys. Include it as ?apiKey=YOUR_KEY on the request URL.
• API token must have permission to access Locations (read) in its permissions profile. See API setup for granting permissions.
• API token must have access to each location that you want it to return.  
• Rate limit: 300 calls per 300 seconds. Exceeding this returns HTTP 429 Too Many Requests.
• When creating a token, it is recommended to restrict allowed IP addresses for the calling servers (optional but recommended).

Step-by-step instructions

1. Generate or copy an API token from Settings → API Keys.
2. Confirm the token has Locations (read) permission in the token's permissions settings.
3. Build a GET request to the locations endpoint and include your apiKey plus any filters:

   GET https://rental.software/api6/locations/?apiKey=XXXXXX&offset=0&limit=25
   	

4. Send the request (example using curl):

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

5. Inspect the JSON response for pagination links and the items array containing category records (id, href, name, order).

Request (format)

GET /api6/locations/{location_id}?apiKey=XXXXXX {
  location_id    <--- optional ID of known location in account to get details about the location
  offset: 0      <--- start at record #
  limit: 25      <--- count of records to return (25 is default)
}

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
}

Feature Options & Parameters

• offset (query) — Start record number for paging. Default: 0.
• limit (query) — Number of records to return. Default: 25.
• Returned fields — The response includes:
  • offset, limit — paging values
  • first, next, previous — paging URLs
  • items — array of location objects: id, href (location endpoint), name

Troubleshooting & FAQs

• No or empty response — Verify you included ?apiKey=YOUR_KEY and that the key is valid. If using wpid, confirm the sync ID is correct; try omitting wpid to list all categories.
• Permission denied / 403 — Check the API token's permissions in Settings → API Keys and ensure it has access to Categories (read).
• 429 Too Many Requests — You exceeded the rate limit (300 calls / 300 seconds). Wait and retry or reduce request frequency.
• Incorrect paging — Use the response's first/next/previous URLs or adjust offset/limit to page through results.
• 404 Not Found — Check the endpoint URL and ensure you are calling the correct environment and API base path (https://rental.software/api6/...).