Skip to main content
Territories let you divide your canvassing area into named geographic zones and assign them to individual reps. Each territory stores a polygon as an array of coordinate pairs, a total property count, and an optional assignee. You can use the territories API to automate territory creation from your own mapping tools, sync assignments from a dispatch system, or simply read back the shapes your team has drawn in the web dashboard.

List territories

Returns all active territories for your company, ordered newest first.

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

All fields are optional. 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.
Returns 201 with the created territory object on success.

Get a territory

Returns a single territory. Returns 404 if it does not exist or belongs to a different company.

Path parameters

number
required
The territory ID.

Update a territory

All body fields are optional. Only the fields you send are updated.

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

Deletes the territory. The record is excluded from list responses immediately but is not permanently destroyed.

Path parameters

number
required
The territory ID.
Returns { "id": <number> } on success.