Lookup lists are the small lists you set up in your account settings: lead statuses, surfaces, delivery methods, customer types, payment types, referrals, worker positions and email templates. Use these endpoints to fill in dropdowns in your own forms, or to make sure a value you send (such as a status name) matches what your account uses.
All of them work the same way, so they are documented together.
Endpoints
| List | URL | Each item contains | Package |
|---|---|---|---|
| Lead statuses | /api6/statuses_list | id, href, name | WP/API |
| Surfaces | /api6/surfaces_list | id, href, title | WP/API |
| Delivery methods | /api6/deliverymethods_list | id, href, title | WP/API |
| Customer types | /api6/customertypes_list | id, href, name | WP/API |
| Payment types | /api6/paymenttypes_list | id, href, name | WP/API |
| Referrals | /api6/referrals_list | id, href, name | WP/API |
| Email templates | /api6/emailtemplates_list | id, href, title, subject, body | WP/API |
| Worker positions | /api6/positions_list | id, href, name | WP/API and Workers |
Base URL: https://rental.software/api6. All of these are GET requests and every request needs your apiKey.
Request
GET /api6/statuses_list?apiKey=YOUR_API_KEY
| Parameter | Default | Description |
|---|---|---|
| apiKey | Required. Your API key | |
| offset | 0 | Record number to start at. The first record is 0 |
| limit | 25 | Count of records to return. If you have more than 25 of something, raise the limit or page through the list |
| _body | false | If true, each item is the full record with all of its settings instead of the short version |
Example using curl:
curl "https://rental.software/api6/statuses_list?apiKey=YOUR_API_KEY&limit=100"
Response
{
"offset": 0,
"limit": "100",
"first": "https://rental.software/api6/statuses_list?offset=0&limit=100",
"next": "https://rental.software/api6/statuses_list?offset=100&limit=100",
"previous": "https://rental.software/api6/statuses_list?offset=0&limit=100",
"items": [
{
"id": "2345",
"href": "https://rental.software/api6/statuses/2345",
"name": "Quote"
},
{
"id": "2349",
"href": "https://rental.software/api6/statuses/2349",
"name": "Hold"
},
{
"id": "2351",
"href": "https://rental.software/api6/statuses/2351",
"name": "Confirmed"
}
],
"request_time": 1760000000
}The other lists have the same shape. Only the fields inside each item differ, as shown in the Endpoints table. The response can include a few extra keys not listed here. Your code should ignore keys it does not use.
Notes for Each List
- Lead statuses: only active statuses are returned, in the order they are arranged in your settings. Use the name as the status when you create or update a lead, and the id in the status[] search parameter of the leads list. With _body=true each status also includes its settings, such as color and the flags confirmed, complete and cancel.
- Surfaces and delivery methods: use the title as the surface or deliverytype when you create or update a lead.
- Customer types: use the name as the customertype when you create or update a customer.
- Payment types: use the name as the type when you record a payment.
- Referrals: use the name as the referral when you create or update a lead.
- Email templates: only active, customer facing templates are returned, sorted by title.
- Worker positions: the id matches the positionid values in worker records.
If the API key is limited to certain locations, a list only includes the entries of those locations and the entries that are not tied to a location.
Tip: these lists change rarely. Fetch them once, store them on your side, and refresh them once a day. That keeps your transaction count low.
Errors
| Status | Message | What to do |
|---|---|---|
| 404 | No statuses found, No surfaces found, No delivery methods found, No paymenttypes found, No positions found, No items found | The list is empty, or you paged past the end. An empty list is reported as a 404, not as an empty items array |
| 405 | Only accepts GET requests | These lists are read only. Use GET |
See API - Errors and Rate Limits for errors that apply to every call.