Get Service Territory Details

Changed on

Returns a single territory's full details, including populated teams and owners. There is no "zones" concept on a territory — the closest equivalents are the geofence boundary (territory_coordinates) or radius (territory_radius), plus the assigned teams/owners.

get/territory/{territory_uid}

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/territory/{territory_uid}
  • Auth
    API key in header x-api-key

Path parameters

territory_uidstring required

Response

200

type'success'
dataobject

territory_name, territory_description, territory_color, territory_uid, territory_type, territory_coordinates, territory_radius, territory_zipcodes, is_active, is_deleted, created_at, updated_at, plus populated teams ([{team: {...}}]), owners ([{owner: {...}}]), and created_by (populated user).

Changes