Skip to content

deskObject

A desk represents an indoor function scope within a business, aggregating stops with similar characteristics under a common indoor owner. Desks are optional — omitting them has no impact on resource allocation.

{
"id": <integer>,
"name": <string> | null,
"livery": [string] | null,
"earliest": <bool> | null,
"active": <bool> | null,
"inSpiral": <bool> | null,
"rank": <integer> | null,
}
id integer
Unique integer identifier.
name string
Display name of the desk (e.g. "PRIMARY GARAGING").
at location
Geographic location. When other criteria match equally, the closest desk wins.
skills [string: skillObject]
Skills covered by this desk (a skill-name map). When non-null the desk must match the stop’s primary option requirements.
livery string
Liveries covered; null selects all liveries.
earliest bool
When true the desk is selected by appointment time relative to now.
active bool
Switches the desk on / off within Spiral.
inSpiral bool
Helix-only — when false the desk is removed from Spiral entirely.
rank integer
Integer ranking; when multiple desks match, the lowest rank is selected.

Desks are processed in priority order: liveryskillrankat. When earliest is set, appointment time (relative to now) is used in the selection.