Skip to main content

Field Mapping

Field mapping tells Staffify how to interpret your API's response. Different PMS systems use different field names, so you need to map them to Staffify's standard fields.

How to Map Fields

  1. 1Click Fetch Sample Data to load fields from your API
  2. 2Detected fields appear in the left column
  3. 3Use dropdowns to map each field to a Staffify field
  4. 4Click Save Field Mapping

Tenant Fields

Staffify FieldDescriptionRequired?
external_idUnique ID from your PMSYes
nameFull name (or use first_name + last_name)Yes
phonePrimary phone numberRecommended
emailEmail addressRecommended
unit_numberUnit/apartment numberNo
rent_amountMonthly rentNo
lease_startLease start dateNo
lease_endLease end dateNo
statusTenant status (active, former, etc.)No

Property Fields

Staffify FieldDescriptionRequired?
external_idUnique ID from your PMSYes
address_line1Street addressYes
cityCityRecommended
stateState/provinceRecommended
postal_codeZIP/postal codeRecommended
unit_numberUnit numberNo
bedsNumber of bedroomsNo
bathsNumber of bathroomsNo
rent_priceListed rent priceNo
statusProperty statusNo

Mapping Example

Your API Response:
{
  "resident_id": "R-12345",
  "full_name": "Sarah Johnson",
  "phone_number": "+15551234567",
  "apartment": "204",
  "monthly_rent": 1850
}

Field Mapping:
  resident_id    →  external_id
  full_name      →  name
  phone_number   →  phone
  apartment      →  unit_number
  monthly_rent   →  rent_amount
Property Management - Field Mapping