---
title: List
slug: bigboxapi/zipcodes-api/list
docTags: 
createdAt: 2024-07-22T08:01:06.003Z
---

# List Zipcodes

<font color="#52c41a">`GET`</font>  `/zipcodes`

To list zipcodes to your account you should make an  `HTTP GET`  request to the List Zipcodes endpoint. You can list zipcodes for a specific  `domain`  and perform a search using the  `search_term`  querystring parameter.

:::hint{type="info"}
**Zipcode Licensing**
To view how many zipcodes you can add to your account you can use the [Account API](https://docs.trajectdata.com/bigboxapi/account-api).
:::

Zipcodes can also be listed and edited visually via the [Dashboard](https://app.bigboxapi.com/zipcodes).

For more information about using zip & postal codes with BigBox API please see the [zipcodes overview](https://docs.trajectdata.com/bigboxapi/zipcodes-api/overview).

***

### Parameters

The following querystring (HTTP GET) parameters allow you to refine the results returned by the List Zipcodes API.

| `Parameter`         | `Required`       | `Description`                                                                                                                                               |
| ------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `api_key`<br />     | `required`<br /> | The API key for your account.<br />                                                                                                                         |
| `search_term`<br /> | `optional`<br /> | Limits the returned zipcodes to just those containing the  `search_term`  i.e.  `search_term=455`  (to return only zipcodes containing the string  `455` ). |
| `domain`<br />      | `optional`<br /> | Filters the zipcodes returned to only those from the domain specified.                                                                                      |
| `page`<br />        | `optional`<br /> | The page of results to return. A maximum of 10 results are returned per page.                                                                               |

### Example

In the example below we List all the zipcodes on your account:

:::CodeblockTabs
```curl
$ curl "https://api.bigboxapi.com/zipcodes?api_key=demo"
```

```nodejs
const axios = require('axios');

axios.get('https://api.bigboxapi.com/zipcodes?api_key=demo')
.then(response => {
  const apiResponse = response.data;

  console.log("Zipcodes: ", JSON.stringify(apiResponse, 0, 2);

}).catch(error => {
  console.error(error);
});
```

```python
import requests
import json

params = {
  'api_key': 'demo'
}

api_result = requests.get('https://api.bigboxapi.com/zipcodes', { params })

api_response = api_result.json()

print "Zipcodes: ", json.dumps(api_response)
```

```php
<?php
      
$queryString = http_build_query([
  'api_key' => 'demo',
]);

$ch = curl_init('https://api.bigboxapi.com/zipcodes', $queryString);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
# the following options are required if you're using an outdated OpenSSL version
# more details: https://www.openssl.org/blog/blog/2021/09/13/LetsEncryptRootCertExpire/
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_TIMEOUT, 180);

$json = curl_exec($ch);
curl_close($ch);

$api_result = json_decode($json, true);

print_r($api_result);

?>
```
:::

An example of a successful response to the List Zipcodes API is shown below:

```json
{
  "request_info": {
    "success": true
  },
  "usage": {
    "used": 2,
    "limit": 10,
    "available": 8
  },
  "zipcodes": {
    "homedepot.com": [
      {
        "zipcode": "30339",
        "status": "preparing"
      }
    ]
  }
}
```

***

**Next Steps**
     [Zipcodes Overview](https://docs.trajectdata.com/bigboxapi/zipcodes-api/overview)
     [Deleting a zipcode via the Zipcodes API](https://docs.trajectdata.com/bigboxapi/zipcodes-api/delete)
     [Add a zipcode via the Zipcodes API](https://docs.trajectdata.com/bigboxapi/zipcodes-api/add)