> ## Documentation Index
> Fetch the complete documentation index at: https://api.docs.dealmachine.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Groups

> How filters and fields are organized into logical groups

Every filter and field belongs to a **group** — a logical category like "Ownership", "Equity", or "Demographics". Groups are shared between the [Filters](/concepts/filters) and [Fields](/concepts/fields) APIs, so the same `group_id` works in both.

Use the `group_id` to organize filter UIs, build category navigation, or request a focused subset of fields.

## Filtering by Group

Pass `group_id` as a query parameter to scope discovery requests:

```bash theme={null}
# Get all fields in the "equity_and_value_info" group
curl "https://api.v2.dealmachine.com/v1/fields?group_id=equity_and_value_info" \
  -H "Authorization: Bearer dm_sk_live_xxx"

# Get all filters in the "owner_type" group
curl "https://api.v2.dealmachine.com/v1/filters?group_id=owner_type" \
  -H "Authorization: Bearer dm_sk_live_xxx"
```

***

## Property Groups

Groups available when `source_type` is `properties`.

| `group_id`               | Display Name              | Description                                                                                          |
| ------------------------ | ------------------------- | ---------------------------------------------------------------------------------------------------- |
| `all_mortgage_info`      | Mortgage                  | Primary mortgage details including lender, balance, rate, loan type, and origination date            |
| `amenities`              | Amenities                 | Property features such as pool, fireplace, garage, air conditioning, and parking                     |
| `assessor`               | Assessed Values           | County tax assessor valuations including land, improvement, and total assessed values                |
| `beds_and_baths`         | Beds and Baths            | Bedroom and bathroom counts                                                                          |
| `building_information`   | Building Information      | Structure details like year built, stories, square footage, and building class                       |
| `condition_and_quality`  | Condition & Quality       | Property condition rating and construction quality grade                                             |
| `construction_materials` | Construction Materials    | Roof type, exterior wall material, foundation, framing, and floor covering                           |
| `equity_and_value_info`  | Equity                    | Estimated equity amount and equity percentage based on current value minus outstanding loans         |
| `flood_information`      | Flood Risk                | FEMA flood zone designation                                                                          |
| `hoa_info`               | HOA                       | Homeowners association fee amount and payment frequency                                              |
| `legal_info`             | Legal                     | APN (assessor parcel number) and legal description of the property                                   |
| `lien_information`       | Liens                     | Tax lien and involuntary lien indicators                                                             |
| `lot_info`               | Lot/Land                  | Lot size in acres and square feet, lot dimensions, and zoning classification                         |
| `mls_info`               | Listing                   | MLS listing status, list price, days on market, and listing date                                     |
| `owner_type`             | Ownership                 | Owner name, occupancy status, absentee owner flag, corporate owner, trust-held, and ownership length |
| `preforeclosure_info`    | Pre-foreclosure & Auction | Foreclosure status, default amount, auction date, trustee info, and recording details                |
| `sale_history`           | Sale History              | Prior sale dates, prices, and buyer/seller information across multiple transactions                  |
| `systems_and_utilities`  | Systems & Utilities       | Heating, cooling, water, sewer, electrical, and fuel type                                            |
| `tax_and_mortgage_info`  | Tax                       | Annual tax amount, tax year, tax rate, and tax delinquency status                                    |

***

## People Groups

Groups available when `source_type` is `people`.

| `group_id`                | Display Name         | Description                                                                                           |
| ------------------------- | -------------------- | ----------------------------------------------------------------------------------------------------- |
| `business_and_employment` | Business/Employment  | Occupation, employer, job title, and business owner indicator                                         |
| `contactability`          | Contactability       | Phone availability, email availability, mailing address status, and contact scoring                   |
| `credit_behavior`         | Credit Behavior      | Credit score range, credit utilization, payment history, and credit age                               |
| `credit_products`         | Credit Products      | Active credit cards, auto loans, student loans, and personal loan indicators                          |
| `demographics`            | Demographics         | Age, gender, marital status, education level, household size, ethnicity, and language                 |
| `income_and_wealth`       | Income & Wealth      | Estimated income range, net worth bracket, discretionary spending, and wealth score                   |
| `insurance_behavior`      | Insurance Behavior   | Insurance product ownership including auto, home, life, and health indicators                         |
| `investment_activity`     | Investment Activity  | Stock/bond investor flag, active investor indicator, investment property count, and portfolio signals |
| `investment_property`     | Investment Property  | Details on owned investment properties including count, value, equity, and location                   |
| `lifestyle`               | Lifestyle Indicators | Lifestyle interest indicators such as outdoor enthusiast, DIY, and charitable donor                   |
| `loans_and_financing`     | Loans & Financing    | Active loan types, recent financing activity, and refinance likelihood                                |
| `politics`                | Politics             | Voter registration status and party affiliation                                                       |
| `primary_mortgage`        | Mortgage             | Mortgage details on the person's primary residence including lender, balance, rate, and term          |
| `primary_property`        | Residence & Property | Primary residence details including property type, value, square footage, and year built              |
| `real_estate`             | Real Estate          | Total properties owned, years as property owner, recent purchase activity, and seller likelihood      |
| `vehicle_ownership`       | Vehicle Ownership    | Vehicle make, model, year, type, fuel type, and estimated value                                       |

***

## Groups vs Source Types

Groups are scoped to a source type. Two groups can share the same display name across source types — for example, both `all_mortgage_info` (properties) and `primary_mortgage` (people) display as "Mortgage", but they contain different fields.

When using `group_id` in API requests, always pair it with the appropriate `source_type`:

```bash theme={null}
# Property mortgage fields
curl "https://api.v2.dealmachine.com/v1/fields?source_type=properties&group_id=all_mortgage_info" \
  -H "Authorization: Bearer dm_sk_live_xxx"

# People mortgage fields
curl "https://api.v2.dealmachine.com/v1/fields?source_type=people&group_id=primary_mortgage" \
  -H "Authorization: Bearer dm_sk_live_xxx"
```
