People
Count People
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 of location objects defining where to search. Required unless filters or protocol filters are provided (max 15). Locations use OR logic.
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).Restrict counts to people list IDs, for example
{ "people_list_ids": [123] }.Exclude people list IDs, for example
{ "people_list_ids": [456] }.Exclude people already exported by your organization.
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, renterResponse Fields
| Field | Type | Description |
|---|---|---|
total_people | integer | Number of people matching the filters |
total_properties | integer | Number of properties connected via property_match. 0 when no property filters are used. |
total_results | integer | Always equals total_people for people search |
Notes
- The same filter validation rules apply as Search People.
property_matchis required when any property filter is present, and ignored when only people filters are used.- When no property filters are present,
total_propertiesis0.