Properties
Admin API for properties under a tenant.
Overview
A Property represents a site (building, community, campus) belonging to exactly one Tenant. Units hang off properties.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /api/admin/properties | List (filter by tenantId) |
POST | /api/admin/properties | Create |
GET | /api/admin/properties/:propertyId | Read |
PUT | /api/admin/properties/:propertyId | Update |
DELETE | /api/admin/properties/:propertyId | Delete |
Requires requirePropertyAccess on single-resource routes.
Fields
| Field | Notes |
|---|---|
tenantId | Required foreign key |
name | Human label |
address | Optional free-form |
timezone | Default America/New_York |
telephonyProviderOverride | Opt property into Telnyx for new VN purchases |
Usage tips
- When onboarding a new customer, create the tenant first, then properties, then units.
- Property-level guest pass policy:
GuestPassPolicymodel (enabled per property). - Property-level analytics roll up from related units and calls.
Last verified: 2026-06-21 (commit 293c4a7)