Skip to main content
POST
Search the DealMachine people/contacts database using filters. Control which fields are returned, how results are paginated and sorted, and optionally include property filters to find people connected to specific types of properties. When property filters are included, set property_match to define the person-to-property relationship. Matching properties are nested in a properties array on each person.

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 — results matching any location are included.
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 results 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. Pass true for defaults or a full Query Builder export exclusion object.
integer
Query Builder dataset environment: 1 production, 2 staging, 3 development.
string[]
Field IDs to include in results. Can include both people and property fields. Omit or pass an empty array for the default set. Property fields appear in the nested properties array when property_match is set.
string
Required when property filters are present. Defines the person-to-property relationship. Ignored when only people filters are used.Options: owner, resident, renter
integer
default:1
Page number (min: 1).
integer
default:25
Results per page (min: 1, max: 250).
array
Array of sort objects for ordering results. See Pagination & Sorting.
boolean
default:false
When true, returns a credit cost estimate without returning data or consuming credits. See Cost Estimate.

Response

Every search response contains four top-level keys: data, totals, credits, and pagination. See Credits for full details on how credits work.

data

An array of person objects. Each person includes the always-included people fields — name, phones, emails, and primary address — plus any fields you requested. Credits are consumed per entity. When property_match is set and property filters are present, each person also includes a properties array with matching properties.
When no property filters are present, property_match is not needed and no properties array is included.

properties

The nested properties array on each person when property_match is set. Each property includes the always-included property fields plus any property fields you requested.

totals

The full count of matching entities across the entire result set, regardless of pagination.

credits

A breakdown of what this request cost. Included on every search response.
Credits are deduplicated within your billing period. If you’ve already accessed a person or property this month, it won’t be charged again — it shows up in deduplicated instead.

pagination


How Property Filters Work

When you include property filters in a people search:
  1. The API finds properties matching the property filters.
  2. It looks up people connected to those properties via the property_match relationship.
  3. It applies any people filters to narrow down the results.
  4. Matching properties are nested in a properties array on each person.
Property fields you request appear on each object in the properties array. Some base property fields (dm_property_id, address, city, state, zip) are always included. If no property filters are present, property_match is not needed and no properties array is included in the response.

Notes

  • At least one location, filter, list condition, or previous-export condition is required. An empty filters array is valid when another search criterion is present.
  • All filters are combined with AND logic. See Searching.
  • property_match is required when any property filter is present, and ignored when only people filters are used.
  • When property_match is set, matching properties appear in a nested properties array on each person. Any property fields you request show up there.
  • All search results are enriched and consume credits per entity. Use estimate_cost: true to preview credit costs before searching.
  • Use source_type=people and source_type=properties when calling List Filters and List Fields to discover available filters and fields.

Cost Estimate

Set estimate_cost: true to preview the credit cost of a search before committing to it. The request is validated identically to a real search — same filters, same pagination — but no data is returned and no credits are consumed.
The response contains totals, pagination, and estimated_credits — but no data array:
Cost estimate is free and does not consume credits. Use it as often as needed. To get just the total count without cost estimates, use Count People.