Skip to main content
GET
Get available zip codes for a country in a package

Authorizations

Authorization
string
header
required

API key secret (starts with s_live_). Create keys in the dashboard under Settings → API keys, or via POST /v1/api-keys/. Send it as Authorization: Bearer <secret>.

Path Parameters

package_id
string
required

The package's ID. To find it, open the package in Packages and expand the header, or call List packages.

cc
string
required

The ISO country code

Query Parameters

network
enum<string> | null

Filter by network type. Valid values are the package's own types (wifi, mobile, or mix); anything else returns 400 listing the networks available on the package.

Available options:
wifi,
mobile,
mix
region
string | null

The region name

city
string | null

The city name

Response

Successful Response

Response schema for list of zip codes available in a country/city for a package.

data
LocationResponse · object[]
required