Propertyware · Schema

Contact

Contact Response

Property ManagementReal EstateRental PropertiesSingle-Family RentalsLeasesTenantsMaintenanceWork OrdersFinancial TransactionsOwner Reports

Properties

Name	Type	Description
address	object
allowESignature	boolean	Indicates if the contact can receive eSignature request e-mail messages sent through Propertyware.
altEmail	string	Alternate e-mail address.
birthDate	string	Date of birth.
category	string	Contact category.
comments	string	Comments.
company	string	Company where the contact is employed.
createdBy	string	User who created the record.
createdDateTime	string	Date and time the record was created. (Timezone: UTC)
customFields	array	Custom fields.
email	string	E-mail address.
fax	string	Fax.
firstName	string	First name.
gender	string	Gender.
homePhone	string	Home phone.
id	integer	Unique identifier.
jobTitle	string	Professional title or position for the contact.
lastModifiedBy	string	User who last modified the record.
lastModifiedDateTime	string	Date and time the record was last modified. (Timezone: UTC)
lastName	string	Last name.
middleName	string	Middle name.
mobilePhone	string	Mobile phone.
nameOnCheck	string	Name on check.
namedOnLease	boolean	Indicates if contact is named on lease.
otherPhone	string	Other phone.
salutation	string	Salutation.
suffix	string	Suffix.
type	string	Contact type.
workPhone	string	Work phone.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Contact",
  "description": "Contact Response",
  "type": "object",
  "properties": {
    "address": {
      "$ref": "#/components/schemas/Address"
    },
    "allowESignature": {
      "type": "boolean",
      "example": false,
      "description": "Indicates if the contact can receive eSignature request e-mail messages sent through Propertyware."
    },
    "altEmail": {
      "type": "string",
      "description": "Alternate e-mail address."
    },
    "birthDate": {
      "type": "string",
      "format": "date",
      "description": "Date of birth."
    },
    "category": {
      "type": "string",
      "description": "Contact category."
    },
    "comments": {
      "type": "string",
      "description": "Comments."
    },
    "company": {
      "type": "string",
      "description": "Company where the contact is employed."
    },
    "createdBy": {
      "type": "string",
      "description": "User who created the record."
    },
    "createdDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time the record was created. (Timezone: UTC)"
    },
    "customFields": {
      "type": "array",
      "description": "Custom fields.",
      "items": {
        "$ref": "#/components/schemas/CustomField"
      }
    },
    "email": {
      "type": "string",
      "description": "E-mail address."
    },
    "fax": {
      "type": "string",
      "description": "Fax."
    },
    "firstName": {
      "type": "string",
      "description": "First name."
    },
    "gender": {
      "type": "string",
      "description": "Gender.",
      "enum": [
        "UNKNOWN",
        "MALE",
        "FEMALE",
        "DECLINE_TO_STATE"
      ]
    },
    "homePhone": {
      "type": "string",
      "description": "Home phone."
    },
    "id": {
      "type": "integer",
      "format": "int64",
      "description": "Unique identifier."
    },
    "jobTitle": {
      "type": "string",
      "description": "Professional title or position for the contact."
    },
    "lastModifiedBy": {
      "type": "string",
      "description": "User who last modified the record."
    },
    "lastModifiedDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time the record was last modified. (Timezone: UTC)"
    },
    "lastName": {
      "type": "string",
      "description": "Last name."
    },
    "middleName": {
      "type": "string",
      "description": "Middle name."
    },
    "mobilePhone": {
      "type": "string",
      "description": "Mobile phone."
    },
    "nameOnCheck": {
      "type": "string",
      "description": "Name on check."
    },
    "namedOnLease": {
      "type": "boolean",
      "example": false,
      "description": "Indicates if contact is named on lease."
    },
    "otherPhone": {
      "type": "string",
      "description": "Other phone."
    },
    "salutation": {
      "type": "string",
      "description": "Salutation."
    },
    "suffix": {
      "type": "string",
      "description": "Suffix."
    },
    "type": {
      "type": "string",
      "description": "Contact type.",
      "enum": [
        "TENANT",
        "PROSPECT",
        "OWNER",
        "VENDOR",
        "OTHER"
      ]
    },
    "workPhone": {
      "type": "string",
      "description": "Work phone."
    }
  }
}