# Get Cities

Returns a list of cities. Maximum [page size](../../../specification/pagination.html#api-pagination) is 1000. Default
page size is 1000.

## Request

HTTP Method: `GET`

URI Path: `/v3/cities`

Note

For all returned data attributes, see [City Object](city-object.html).

### URI Query Parameters

| Name | Type | Is Required? | Description |
| --- | --- | --- | --- |
| include | `string` | No | [Inclusion](../../../specification/includes.html#api-includes) |
| filter[<filter\_name>] | `string`, `boolean` | No | [Filtering](../../../specification/filtering.html#api-filters) |
| fields[cities] | `string` | No | [Sparse fieldsets](../../../specification/sparse-fieldsets.html#api-sparse-fieldsets) |
| sort | `string` | No | [Sorting](../../../specification/sorting.html#api-sorting) |

### Includes

| Value | Description |
| --- | --- |
| country | [Country Object](../countries/country-object.html#country-object-v34) |
| region | [Region Object](../regions/region-object.html#region-object-v34) |
| area | [Area Object](../../regulation-resources/areas/area-object.html#area-object-v34) |

### Filters

| Filter Name | Type | Allow Blank | Allow Array | Filters by: |
| --- | --- | --- | --- | --- |
| id | `string` | No | Yes | City `id` field. |
| name | `string` | Yes | Yes | City `name` field. Case insensitive. |
| country.id | `string` | Yes | Yes | A `country.id` field. |
| region.id | `string` | Yes | Yes | A `region.id` field. |
| is\_available | `boolean` | No | No | Indicates if DID numbers in the specified city are currently available for purchase |
| area.id | `string` | Yes | Yes | A `area.id` field. |

### Sorting

| Value | Sort by |
| --- | --- |
| name | City `name` field. |

## Examples

Simple requestFilter by name or country.idInclude Country Resource

[[DIDWW-API-EXAMPLE-START]]

http

```
GET /v3/cities HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API Token]
```

curl

```
curl -i -X GET https://api.didww.com/v3/cities -H "Accept: application/vnd.api+json" -H "Api-Key: [API Token]" -H "Content-Type: application/vnd.api+json"
```

response

```
HTTP/2 200 OK
Content-Type: application/vnd.api+json

{
  "data": [
    {
      "id": "dccb89ba-f777-4128-b99b-b25e19ccf4ea",
      "type": "cities",
      "attributes": {
        "name": "Aachen"
      },
      "relationships": {
        "country": {
          "links": {
            "self": "https://api.didww.com/v3/cities/dccb89ba-f777-4128-b99b-b25e19ccf4ea/relationships/country",
            "related": "https://api.didww.com/v3/cities/dccb89ba-f777-4128-b99b-b25e19ccf4ea/country"
          }
        },
        "region": {
          "links": {
            "self": "https://api.didww.com/v3/cities/dccb89ba-f777-4128-b99b-b25e19ccf4ea/relationships/region",
            "related": "https://api.didww.com/v3/cities/dccb89ba-f777-4128-b99b-b25e19ccf4ea/region"
          }
        },
        "area": {
          "links": {
            "self": "https://api.didww.com/v3/cities/dccb89ba-f777-4128-b99b-b25e19ccf4ea/relationships/area",
            "related": "https://api.didww.com/v3/cities/dccb89ba-f777-4128-b99b-b25e19ccf4ea/area"
          }
        }
      }
    }
  ]
}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
GET /v3/cities?filter%5Bname%5D=Springfield&filter%5Bcountry.id%5D=3b11ad09-dc7e-451a-9d32-ae9c1604aaa8 HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API Token]
```

curl

```
curl -i -X GET 'https://api.didww.com/v3/cities?filter%5Bname%5D=Springfield&filter%5Bcountry.id%5D=3b11ad09-dc7e-451a-9d32-ae9c1604aaa8' -H "Accept: application/vnd.api+json" -H "Api-Key: [API Token]" -H "Content-Type: application/vnd.api+json"
```

response

```
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": [
    {
      "id": "79c1ee51-a2dd-4fb2-8c08-ab9120909118",
      "type": "cities",
      "attributes": {
        "name": "Springfield"
      },
      "relationships": {
        "country": {
          "links": {
            "self": "https://api.didww.com/v3/cities/79c1ee51-a2dd-4fb2-8c08-ab9120909118/relationships/country",
            "related": "https://api.didww.com/v3/cities/79c1ee51-a2dd-4fb2-8c08-ab9120909118/country"
          }
        },
        "region": {
          "links": {
            "self": "https://api.didww.com/v3/cities/79c1ee51-a2dd-4fb2-8c08-ab9120909118/relationships/region",
            "related": "https://api.didww.com/v3/cities/79c1ee51-a2dd-4fb2-8c08-ab9120909118/region"
          }
        },
        "area": {
          "links": {
            "self": "https://api.didww.com/v3/cities/79c1ee51-a2dd-4fb2-8c08-ab9120909118/relationships/area",
            "related": "https://api.didww.com/v3/cities/79c1ee51-a2dd-4fb2-8c08-ab9120909118/area"
          }
        }
      }
    }
  ]
}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
GET /v3/cities?include=country HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API Token]
```

curl

```
curl -i -X GET 'https://api.didww.com/v3/cities?include=country' -H "Accept: application/vnd.api+json" -H "Api-Key: [API Token]" -H "Content-Type: application/vnd.api+json"
```

response

```
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": [
    {
      "id": "79c1ee51-a2dd-4fb2-8c08-ab9120909118",
      "type": "cities",
      "attributes": {
        "name": "Springfield"
      },
      "relationships": {
        "country": {
          "links": {
            "self": "https://api.didww.com/v3/cities/79c1ee51-a2dd-4fb2-8c08-ab9120909118/relationships/country",
            "related": "https://api.didww.com/v3/cities/79c1ee51-a2dd-4fb2-8c08-ab9120909118/country"
          }
        },
        "region": {
          "links": {
            "self": "https://api.didww.com/v3/cities/79c1ee51-a2dd-4fb2-8c08-ab9120909118/relationships/region",
            "related": "https://api.didww.com/v3/cities/79c1ee51-a2dd-4fb2-8c08-ab9120909118/region"
          }
        },
        "area": {
          "links": {
            "self": "https://api.didww.com/v3/cities/79c1ee51-a2dd-4fb2-8c08-ab9120909118/relationships/area",
            "related": "https://api.didww.com/v3/cities/79c1ee51-a2dd-4fb2-8c08-ab9120909118/area"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "3b11ad09-dc7e-451a-9d32-ae9c1604aaa8",
      "type": "countries",
      "attributes": {
        "name": "United States",
        "prefix": "1",
        "iso": "US"
      }
    }
  ]
}
```

[[DIDWW-API-EXAMPLE-END]]

## Other Responses

| Code | Success | Description |
| --- | --- | --- |
| 401 | No | [Unauthorized](../../../configuration.html#api-key) |

On this page