Skip to main content
GET
/
v1
/
fields
curl "https://api.v2.dealmachine.com/v1/fields?source_type=properties&per_page=50" \
  -H "Authorization: Bearer dm_sk_live_xxx"

{
  "data": [
    {
      "field_id": "estimated_value",
      "name": "Estimated Value",
      "description": "Current estimated market value of the property",
      "type": "NUMBER",
      "source_type": "properties",
      "group_id": "financial",
      "is_filterable": true,
      "is_sortable": true
    },
    {
      "field_id": "property_address_city",
      "name": "Property Address City",
      "description": "City where the property is located",
      "type": "STRING",
      "source_type": "properties",
      "group_id": "location",
      "is_filterable": true,
      "is_sortable": true
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 50,
    "total_results": 180,
    "total_pages": 4,
    "has_next_page": true,
    "has_previous_page": false
  }
}
Discover all available fields for properties and people. Returns field metadata including data types, capabilities, and grouping information. Use this endpoint to understand what data is available via the API before requesting property or contact records.

​
Query Parameters

ParameterTypeDescription
source_typestringFilter by source type: properties or people
group_idstringFilter by group ID (e.g., financial, property_details, ownership)
searchstringSearch fields by name or description
pageintegerPage number (default: 1, min: 1)
per_pageintegerResults per page (default: 25, min: 1, max: 250)
curl "https://api.v2.dealmachine.com/v1/fields?source_type=properties&per_page=50" \
  -H "Authorization: Bearer dm_sk_live_xxx"

{
  "data": [
    {
      "field_id": "estimated_value",
      "name": "Estimated Value",
      "description": "Current estimated market value of the property",
      "type": "NUMBER",
      "source_type": "properties",
      "group_id": "financial",
      "is_filterable": true,
      "is_sortable": true
    },
    {
      "field_id": "property_address_city",
      "name": "Property Address City",
      "description": "City where the property is located",
      "type": "STRING",
      "source_type": "properties",
      "group_id": "location",
      "is_filterable": true,
      "is_sortable": true
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 50,
    "total_results": 180,
    "total_pages": 4,
    "has_next_page": true,
    "has_previous_page": false
  }
}

​
Response Fields

The response follows the standard response envelope with a data array and pagination object. Each field object in data contains:
FieldTypeDescription
field_idstringUnique identifier for the field (e.g., estimated_value)
namestringDisplay name
descriptionstring | nullHuman-readable description
typestring | nullData type (e.g., NUMBER, STRING, DATE, MULTI_SELECT, BOOLEAN)
source_typestring | nullproperties or people
group_idstring | nullField group identifier (e.g., financial, property_details)
is_filterablebooleanWhether this field can be used as a filter
is_sortablebooleanWhether this field can be used for sorting results
Only fields marked as available for the public API are returned. Internal-only fields are excluded. Use is_filterable to determine which fields can be used with the List Filters endpoint. Use is_sortable to determine which fields can be used for sorting in list endpoints.