Get Service Territories

get

https://{dc-region}.zuperpro.com/api/territory

Lists service territories. Role-based auto-scoping applies: a Team Leader only sees territories owned/created by users on their teams; a Field Executive only sees their own owned/created territories.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

int32

Defaults to 1

count

int32

Defaults to 10

sort

string

enum

Defaults to DESC

Allowed:

sort_by

string

enum

Allowed:

filter.keyword

string

For search (includes only territory_name)

filter.is_active

boolean

filter.type

string

created_at

filter.updated_at_from

string

Must be sent together with the other updated_at bound. Strict format: YYYY-MM-DDTHH:mm:ssZ, YYYY-MM-DD HH:mm:ss, YYYY-MM-DDTHH:mm:ss.SSSZ, or YYYY-MM-DD HH:mm:ss.SSS.

filter.updated_at_to

boolean

Must be sent together with the other updated_at bound. Strict format: YYYY-MM-DDTHH:mm:ssZ, YYYY-MM-DD HH:mm:ss, YYYY-MM-DDTHH:mm:ss.SSSZ, or YYYY-MM-DD HH:mm:ss.SSS.

filter.zip_code

string

filter.location

string

"," — applied as an in-memory geo filter (point-in-radius for RADIUS territories, point-in-polygon for GEOFENCE) after the DB query, so pagination totals reflect the post-filter count.

filter.territory_uid

string

filter.user_uid

string

filter.team_uid

string

populate_owners

boolean

If true, populates owners with user details.

populate_teams

boolean

If true, populates teams with team details.

filter.owned

boolean

If true, restricts to territories where the requesting user is listed in owners.

Responses

200200

400400

401401