Skip to main content
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
Array of location objects defining where to search. Required unless filters or protocol filters are provided (max 15). Locations use OR logic.
array
Array of filter objects. Required unless locations or protocol filters are provided. You can mix property filters (source_type=properties) and people filters (source_type=people).
object
Restrict counts to property list IDs, for example { "property_list_ids": [123] }.
object
Exclude property list IDs, for example { "property_list_ids": [456] }.
boolean | object
Exclude records already exported by your organization.
string
default:"properties"
Controls which entity is counted as total_results.Use properties to count matching properties. Use people to count matching people; this requires contact_audience.
string
Which contacts to count. Required when anchor is people, optional when properties.Options: owners, owners_and_family, renters, residents

Response Fields

Notes

  • The same filter validation rules apply as Search Properties.
  • contact_audience is required when anchor is "people" and optional when anchor is "properties".