Skip to main content
POST
Returns the total number of people and properties matching a set of filters. Use the same filters and property_match parameters as Search People.

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 people filters (source_type=people) and property filters (source_type=properties).
object
Restrict counts to people list IDs, for example { "people_list_ids": [123] }.
object
Exclude people list IDs, for example { "people_list_ids": [456] }.
boolean | object
Exclude people already exported by your organization.
string
Required when property filters are present. Defines the person-to-property relationship used to connect people to matching properties. Ignored when only people filters are used.Options: owner, resident, renter

Response Fields

Notes

  • The same filter validation rules apply as Search People.
  • property_match is required when any property filter is present, and ignored when only people filters are used.
  • When no property filters are present, total_properties is 0.