Properties

Buildings, communities, and complexes — the top of the CDM hierarchy. Read-only: list and retrieve.

get/v1/properties

List properties

Query parameters

  • limit integer — Page size, 1–100.
  • offset integer — Zero-based record offset.
  • include_deleted boolean — Include soft-deleted records.
  • updated_after string — Return records with updated_at >= this ISO 8601 datetime.
  • created_after string — Return records with created_at >= this ISO 8601 datetime.
  • created_before string — Return records with created_at <= this ISO 8601 datetime.
  • x_id string — External PMS identifier (exact match). Comma-separated list matches ANY (OR).
  • integration_id string — Integration UUID (exact match). Comma-separated list of UUIDs matches ANY (OR).
  • order-by string
  • status string — Exact match; comma-separated list matches ANY (OR).
  • type string — Exact match; comma-separated list matches ANY (OR).
  • name string — Case-insensitive substring match.

Response · 200

Page of properties

FieldTypeDescription
meta*object
FieldTypeDescription
limit*integer
offset*integer
hasMore*boolean
results*array<object>
FieldTypeDescription
id*string
x_id*string
organization_id*string (uuid)
integration_id*string (uuid)
namestring | null
typestring | null
statusstring | null
addressobject | null
descriptionstring | null
year_builtinteger | null
total_unitsinteger | null
total_buildingsinteger | null
total_floorsinteger | null
website_urlstring | null
emailstring | null
phonesarray<object> | null
latitudenumber | null
longitudenumber | null
timezone_idstring | null
management_company_namestring | null
tax_idstring | null
pet_policystring | null
smoking_policystring | null
mediaarray<object> | null
custom_data*object
created_at*string (date-time)
updated_at*string (date-time)
deleted_atstring (date-time) | null
ps_synced_atstring (date-time) | null

Errors

  • 400 — Validation error
  • 401 — Missing or invalid API key
  • 429 — Rate limit exceeded

Example

GET /v1/properties
{
  "meta": {
    "limit": 25,
    "offset": 0,
    "hasMore": true
  },
  "results": [
    {
      "id": "prp_01HX0G5T8N3KEWBYV2QMR4DCFA",
      "x_id": "entrata-property-3391",
      "organization_id": "b3f1c2d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "integration_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Maple Court Apartments",
      "type": "apartment",
      "status": "active",
      "custom_data": {},
      "created_at": "2026-05-01T09:12:44Z",
      "updated_at": "2026-05-11T18:04:58Z"
    }
  ]
}
get/v1/properties/{id}

Retrieve a property

Path & headers

  • id · path · required

Query parameters

  • include_deleted boolean — Include soft-deleted records.

Response · 200

The property

FieldTypeDescription
id*string
x_id*string
organization_id*string (uuid)
integration_id*string (uuid)
namestring | null
typestring | null
statusstring | null
addressobject | null
descriptionstring | null
year_builtinteger | null
total_unitsinteger | null
total_buildingsinteger | null
total_floorsinteger | null
website_urlstring | null
emailstring | null
phonesarray<object> | null
latitudenumber | null
longitudenumber | null
timezone_idstring | null
management_company_namestring | null
tax_idstring | null
pet_policystring | null
smoking_policystring | null
mediaarray<object> | null
custom_data*object
created_at*string (date-time)
updated_at*string (date-time)
deleted_atstring (date-time) | null
ps_synced_atstring (date-time) | null

Errors

  • 400 — Validation error
  • 401 — Missing or invalid API key
  • 404 — Resource not found
  • 429 — Rate limit exceeded

Example

GET /v1/properties/{id}
{
  "id": "prp_01HX0G5T8N3KEWBYV2QMR4DCFA",
  "x_id": "entrata-property-3391",
  "organization_id": "b3f1c2d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
  "integration_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Maple Court Apartments",
  "type": "apartment",
  "status": "active",
  "address": {
    "line_1": "1400 Maple Court",
    "line_2": null,
    "city": "Austin",
    "state": "TX",
    "postal_code": "78704",
    "country": "US"
  },
  "description": "Garden-style community near South Lamar.",
  "year_built": 2014,
  "total_units": 188,
  "total_buildings": 6,
  "total_floors": 3,
  "website_url": "https://maplecourt.example.com",
  "email": "leasing@maplecourt.example.com",
  "phones": [
    {
      "type": "work",
      "number": "+15125550133",
      "primary": true
    }
  ],
  "latitude": 30.2451,
  "longitude": -97.7689,
  "management_company_name": "Lamar Residential",
  "pet_policy": "restricted",
  "smoking_policy": "not_allowed",
  "media": [],
  "custom_data": {},
  "created_at": "2026-05-01T09:12:44Z",
  "updated_at": "2026-05-11T18:04:58Z",
  "deleted_at": null
}

Next

See the Operations page for the async write-back flow, or the Common Data Model for the full entity shapes.