Units
Admin API for units — buzzer destinations and resident links.
Overview
A Unit is the entity visitors select at the intercom. It links to a property, optional virtual number (e164), and many resident users.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /api/admin/units | List (filter by property, tenant) |
POST | /api/admin/units | Create |
GET | /api/admin/units/:unitId | Read |
GET | /api/admin/units/:unitId/invites | List unit invites |
PUT | /api/admin/units/:unitId | Update |
POST | /api/admin/units/:unitId/residents | Add resident to unit |
DELETE | /api/admin/units/:unitId/residents/:userId | Remove resident |
DELETE | /api/admin/units/:unitId | Delete |
Critical field: unitLabel
The human-visible apartment identifier is unitLabel. APIs and integrations must not use deprecated names like number or name.
Virtual numbers
virtualNumberId ties the unit to a pooled carrier number (Twilio or Telnyx). Releasing or quarantining numbers flows through Virtual numbers API.
Residents
Residents associate through the many-to-many relation. Use POST .../residents to link users — do not hand-edit UUIDs in production.
Last verified: 2026-06-21 (commit 293c4a7)