General

Archivable

Some data types include the ability to soft-delete records sometimes known as archiving. Most of these data types have an endpoint that can soft-delete, hard-delete, and restore records.

Archivable data types have a standard boolean field called isDeleted. When getting a list of Archivable records, you can filter them by passing the showArchived field. Possible values are:

• false - Default, only return non-archived (non-deleted) records
• true - only return archived records
• "all" - return all records, both archived and non-archived

{
  "showArchived": "all"
}

Audit Columns

{
  "createdBy": "U:2006a711-f272-45a8-afce-57a775bf4256",
  "updatedBy": "U:2006a711-f272-45a8-afce-57a775bf4256",
  "createdAt": 1716238007558,
  "updatedAt": 1716238007558
}

Blurhashes

Several objects such as Users, Companies, and Teams use a blurhash as a placeholder while their actual avatars load. Please refer to https://blurha.sh/ for more information.

LatLng

A LatLng object is a pair of floating-point numbers representing a geographic point. The first number is the latitude, and the second number is the longitude.

{
  "latitude": 37.7749,
  "longitude": -122.4194
}

SmallLocationData

A SmallLocationData object contains location information about a location.

Field	Type	Description
locationId	LocationId	The unique identifier of this location
latlng	LatLng	The latitude and longitude of the location
line1	string	The street address of the location
line2	string	The city, state, and zip of the location
countrySubd	string	The two-letter U.S state abbreviation
locality	string	The city name
postal1	string	The U.S postal code

Timestamps

Unless otherwise specified, all dates are in milliseconds since the Unix epoch.

TinyResidentData

A TinyResidentData object contains information about a resident

Field	Type	Description
firstName	LocationId	(Optional) The first name of the resident
lastName	LatLng	(Optional) The last name of the resident
email	string	(Optional) The email address of the resident
phone	string	(Optional) The primary phone number of the resident
phone2	string	(Optional) The secondary phone number of the resident
businessName	string	(Optional) The business name of the property if it is not a residential home