Retrieve the saved filters of your account. The main use is to find the name or ID of a lead filter, which you can then pass to the leads list to get only the leads that match it.
| Action | Method | URL | Package |
|---|---|---|---|
| List filters | GET | https://rental.software/api6/filters_list | WP/API |
| Read one filter | GET | https://rental.software/api6/filters/{filter_id} | WP/API |
List Filters
GET /api6/filters_list?apiKey=YOUR_API_KEY&limit=100
| 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 |
| name | Only filters whose name contains this text. Available starting with the October 2026 release | |
| type | Only filters of this type, for example lead. Available starting with the October 2026 release |
Example using curl:
curl "https://rental.software/api6/filters_list?apiKey=YOUR_API_KEY&limit=100"
Response
{
"offset": 0,
"limit": "100",
"first": "https://rental.software/api6/filters_list?offset=0&limit=100",
"next": "https://rental.software/api6/filters_list?offset=100&limit=100",
"previous": "https://rental.software/api6/filters_list?offset=0&limit=100",
"items": [
{
"id": "4471",
"name": "Akron Events Next 30 Days",
"type": "lead",
"description": "Event City contains \"Akron\" AND Event Date Next 30 days",
"conditions": [
{
"join": null,
"rules": [
{
"join": null,
"field": "Event City",
"operator_text": "contains",
"value": "Akron",
"text": "Event City contains \"Akron\""
},
{
"join": "AND",
"field": "Event Date",
"operator_text": "Next X days",
"value": "30",
"text": "Event Date Next 30 days"
}
]
}
]
}
],
"request_time": 1760000000
}The example is shortened. Each filter contains more fields than shown here, and your code should ignore fields it does not use.
Starting with the October 2026 release: each filter also includes description and conditions, as shown above. description is a one line, readable summary of what the filter matches. conditions gives the same rules in a structured form. The list then also includes filters that were built by a worker or shared with the API key, the same ones the Filters screen shows.
Read One Filter
curl "https://rental.software/api6/filters/4471?apiKey=YOUR_API_KEY"
The answer is a single filter with the same fields as an item in the list.
Using a Filter With the Leads List
Pass the filter's name (or its id) as filter on the leads list:
curl "https://rental.software/api6/leads?apiKey=YOUR_API_KEY&filter=Akron%20Events%20Next%2030%20Days"
Only lead filters ("type": "lead") work there. See API - Leads - Retrieve List.
Filters are created and changed in the software, under Filters. This endpoint is for reading them. See Filters.
Errors
| Status | Message | What to do |
|---|---|---|
| 404 | No items found | No filters matched, or you paged past the end of the list |
| 404 | Item not found | No filter with that ID is available to the API key |
See API - Errors and Rate Limits for errors that apply to every call.