List territories
Response
Returns an array of territory objects directly (not paginated).number
Territory ID.
string
Display name of the territory.
number[][]
Array of
[lng, lat] coordinate pairs forming a closed ring. Minimum 3 points.number
Estimated number of properties within this territory.
number | null
ID of the user assigned to this territory, or
null if unassigned.number
Your company ID.
string
ISO 8601 creation timestamp.
string
ISO 8601 last-updated timestamp.
Create a territory
name defaults to "Untitled Territory", polygon defaults to [], and totalProperties defaults to 0 if omitted.
Request body
string
Display name. Defaults to
"Untitled Territory" if not provided.number[][]
Array of
[lng, lat] coordinate pairs. Must have at least 3 points to define a valid polygon.number
Integer count of properties inside the territory boundary.
number
ID of the user to assign this territory to. Pass
null to leave unassigned.201 with the created territory object on success.
Get a territory
404 if it does not exist or belongs to a different company.
Path parameters
number
required
The territory ID.
Update a territory
Path parameters
number
required
The territory ID.
Request body
string
New display name.
number[][]
Replacement polygon. Must have at least 3
[lng, lat] pairs.number
Updated property count.
number
New assignee user ID. Pass
null to unassign.Delete a territory
Path parameters
number
required
The territory ID.
{ "id": <number> } on success.
