List Territories

get

https://api.genability.com/rest/public/territories

Return a full or filtered list of Territories.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Use this endpoint to return a full or filtered list of territories.

When to use this endpoint

Use GET /rest/public/territories when you need to:

Find territories for a ZIP or postal code, address, or latitude and longitude.
Filter territories for a specific LSE.
Retrieve tariff-related territories, such as baseline regions, by using usageTypes.
Return territory items or associated LSEs when you need additional context.

Common filters

Parameter	Type	Description
`zipCode`	String	Filters territories to those that include this ZIP code.
`postCode`	String	Alias for `zipCode`.
`country`	String	ISO country code. Defaults to `US` when `zipCode` or `postCode` is populated.
`addressString`	String	Address string used to find matching territories.
`lat` / `lng`	Float	Latitude and longitude pair used when not supplying a ZIP code or address.
`lseId`	Integer	Filters territories to those within a specific LSE ID.
`populateItems`	Boolean	When true, returns territory items for each territory.
`masterTariffId`	Integer	Returns territories covered by a tariff when the tariff has territory-based pricing.
`usageTypes`	String	Filters territories by usage type.
`populateLses`	Boolean	When true, returns LSEs that provide service in each territory.

Related endpoints

map-marked-alt

Territories Overview

Learn how territory data is modeled.

map-location-dot

Get Territory by ID

Retrieve one territory by territoryId.

file-invoice-dollar

List Tariffs

Find tariffs that may depend on territory data.

Request Parameters

Along with the standard pagination parameters, searching and sorting parameters, and the required security parameters, the following parameters are available as part of the request:

Query Params

zipCode

string

Filters the result to include only territories that this ZIP code is a part of.

postCode

string

Alias for zipCode, you can use either.

country

string

Recommended when passing in zipCode or postCode. We default this to US when zipCode or postCode is populated.

addressString

string

An address of any kind (e.g. San Francisco, CA, 94105, USA). Ideally this will contain a zipcode or post code, plus a country. Use this if you do not have the address parsed out in your app. If you do, its better to use postCode and country

address

string

Alias for addressString, you can use either.

lat

float

(Optional) Represents the latitude of a geographical location. This should be paired with lng when not supplying a zip code or address.

lng

float

(Optional) Represents the longitude of a geographical location. This should be paired with lat when not supplying a zip code or address.

lseId

int32

Filters the result set to only include territories within this LSE ID

populateItems

boolean

Defaults to false

If true, this returns a list of territory items for each territory in the result set.

masterTariffId

int32

For tariffs with prices varying by geographic location, this will return the list of those territories covered by this tariff. 3% of all tariffs have territory based pricing and those are typically in CA, NY and MA. For the 97% of tariffs that do not have territory based pricing, the result set will be empty.

usageTypes

string

Result will include territories of the specified usageType. If not set the results will be limited to those of usage type "SERVICE" or "TARIFF".

populateLses

boolean

Defaults to false

If true, this returns a list of territory LSEs which are all the LSEs providing service in this territory.

containsItemType

string

Filters by the type of the territory items in each territory and must appear with containsItemValue. Possible values are: STATE, COUNTY, CITY, and ZIPCODE.

containsItemValue

string

Filters by the value of the territory items in each territory and must appear with containsItemType.

Responses

When to use this endpoint

Common filters

Related endpoints

Request Parameters

200200

400400