Properties
Count Properties
POST
Returns the total number of properties and people matching a set of filters. Use the same
filters, anchor, and contact_audience parameters as Search Properties.
Body Parameters
Array of location objects defining where to search. At least one location is required (max 15). Locations use OR logic.
Array of filter objects. At least one filter is required. You can mix property filters (
source_type=properties) and people filters (source_type=people).Controls which entity is counted as
total_results.properties—total_resultsreflects the number of matching properties.people—total_resultsreflects the number of matching people. Requirescontact_audience.
Which contacts to count. Required when
anchor is people, optional when properties.Options: owners, owners_and_family, renters, residentsResponse Fields
| Field | Type | Description |
|---|---|---|
total_properties | integer | Number of properties matching the filters |
total_people | integer | Number of people matching the filters and contact_audience |
total_results | integer | Equals total_properties when anchor is properties, or total_people when anchor is people |
Notes
- The same filter validation rules apply as Search Properties.
contact_audienceis required whenanchoris"people"and optional whenanchoris"properties".