id | string | no | - | |
callsign | string | no | - | Two-word callsign: the stored slug for real docks, derived from the id for synthetic rows. |
name | string | no | - | |
dockNumber | integer | no | - | The per-organization ordinal behind the Dock-00N label. Unique within the owning organization and never reused. |
sourcePinClientId | string or null | no | - | The dashboard placement pin this dock was created from, or null for a dock that came from no pin. Lets a dashboard show the pin and the dock as one card. |
isPlanned | boolean | no | - | True for a dock the organization has placed but whose hardware does not exist yet. A planned dock is editable but never commandable, and never appears outside its owning organization. |
rooftop | object or null | no | - | The dock’s Site (legacy name retained). Null when the dock has been provisioned with no location yet; set later by the customer in settings. |
latitude | number or null | no | - | Null together with longitude when the dock has no location yet. |
longitude | number or null | no | - | Null together with latitude when the dock has no location yet. |
status | string | no | - | Open set; stored status only, not derived from live occupancy. |
pricePerMinute | number or null | no | - | Null when not yet priced, distinct from 0, which is a deliberately free dock. |
createdAt | string | no | format: date-time | |
earningsToDate | number | no | - | Always 0 until the v2 booking backend lands. |
commandable | boolean | no | - | Whether this caller may command the dock right now: a machine is wired to it, and the credential is entitled to actuate it (Operator or above in the owning organization, a command grant, or the open network). Per caller. The actuation operations under /api/v1/docks/{dockId}/commands only succeed when this is true; the machine address itself never crosses the wire. |
hasCamera | boolean | no | - | Whether this caller may watch the live pad camera: a camera module is fitted, a machine is wired, and the caller may command the dock. Per caller, like commandable. |
canEditDock | boolean | no | - | Whether this caller may edit the dock’s record (Operator or above in the owning organization). Per caller. |
canManage | boolean | no | - | Whether this caller may delete the dock (admin or owner of the owning organization). Per caller. |
