Retrieve a paged list of the customers in your account. Use it to sync customers into another system or to look up customer IDs for other API calls.
| Method | URL | API key permission | Package |
|---|---|---|---|
| GET | https://rental.software/api6/customers | Customers: Read Only or Full Access | WP/API |
Request
GET /api6/customers/?apiKey=YOUR_API_KEY&offset=0&limit=2
| Parameter | Required | Default | Description |
|---|---|---|---|
| apiKey | Yes | Your API key | |
| offset | No | 0 | Record number to start at. The first record is 0 |
| limit | No | 25 | Count of records to return |
| _body | No | false | If true, returns more details for each customer (adds tags). The request may take a little longer |
Example using curl:
curl "https://rental.software/api6/customers?apiKey=YOUR_API_KEY&offset=0&limit=2"
Response
{
"offset": 0,
"limit": "2",
"first": "https://rental.software/api6/customers?offset=0&limit=2",
"next": "https://rental.software/api6/customers?offset=2&limit=2",
"previous": "https://rental.software/api6/customers?offset=0&limit=2",
"items": [
{
"id": "533295",
"createtime": "2025-09-29T16:47:54-04:00",
"modifiedtime": "2025-09-29T16:47:54-04:00",
"organization": "",
"firstname": "John",
"lastname": "Smith",
"street": "123 Hello St",
"city": "Akron",
"state": "OH",
"zip": "44314",
"country": "",
"homephone": "",
"officephone": "",
"cellphone": "",
"fax": "",
"email": "",
"notes": "",
"customertype": "Commercial",
"locationid": "0",
"href": "https://rental.software/api6/customers/533295",
"createtime_ts": "1759178874",
"createtime_utc": "2025-09-29T20:47:54Z",
"modifiedtime_ts": "1759178874",
"modifiedtime_utc": "2025-09-29T20:47:54Z"
},
{
"id": "533296",
"createtime": "2025-09-29T16:49:10-04:00",
"modifiedtime": "2025-09-29T16:49:28-04:00",
"organization": "",
"firstname": "Billy",
"lastname": "Jones",
"street": "",
"city": "",
"state": "OH",
"zip": "",
"country": "",
"homephone": "",
"officephone": "",
"cellphone": "(330) 555-0144",
"fax": "",
"email": "",
"notes": "",
"customertype": "Commercial",
"locationid": "0",
"href": "https://rental.software/api6/customers/533296",
"createtime_ts": "1759178950",
"createtime_utc": "2025-09-29T20:49:10Z",
"modifiedtime_ts": "1759178968",
"modifiedtime_utc": "2025-09-29T20:49:28Z"
}
],
"request_time": 1760000000
}Good to Know
- Customers are sorted by last name, then first name.
- This call has no search parameters. You cannot look a customer up by name or email with it. To find one customer, page through the list, or keep the customer ID that is returned when you create the customer.
- Custom fields are not included in the list. Retrieve the single customer to get them. See API - Customers - Retrieve Details.
- If the API key is limited to certain locations, only customers in those locations are returned.
- The first, next and previous links do not include your API key. Add &apiKey=YOUR_API_KEY before calling one.
Paging Through All Customers
- Start with offset=0 and a limit such as 100.
- Add the limit to the offset for each following call (offset=100, offset=200, and so on).
- Stop when a page comes back with fewer items than your limit. That was the last page.
The next link is always present, even on the last page. If you request a page past the end, the API answers with HTTP 404 and the message "No customers found".
Errors
| Status | Message | What to do |
|---|---|---|
| 403 | Permission access restricted | Give the API key Customers access under Settings > API Keys |
| 404 | No customers found | There are no customers at that offset. You have reached the end of the list |
| 405 | Only accepts GET requests | Use GET for the list. To create a customer see API - Customers - Create or Update |
See API - Errors and Rate Limits for errors that apply to every call.