GET
/
list
/
zip
Get All Available Zip Codes
curl --request GET \
  --url https://api.shovels.ai/v2/list/zip \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "zip_code": "90001"
    },
    {
      "zip_code": "90002"
    },
    {
      "zip_code": "90003"
    },
    {
      "zip_code": "90004"
    },
    {
      "zip_code": "90005"
    },
    {
      "zip_code": "90006"
    },
    {
      "zip_code": "90007"
    },
    {
      "zip_code": "90008"
    },
    {
      "zip_code": "90009"
    },
    {
      "zip_code": "90010"
    }
  ],
  "page": 1,
  "size": 50,
  "next_page": 2
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
size
integer
default:50

Number of items per page

Required range: 1 <= x <= 100

Response

200
application/json

A list of available ZIP codes

Paginated response for ZIP codes view.