Get Cities#

Description

Returns a list of cities. Maximum page size is 1000. Default page size is 1000.

Request#

HTTP Method: GET

URI Path: /v3/cities

URI Query Parameters:

Name

Type

Is Required?

Description

filter[<filter_name>]

string, boolean

Optional

Filtering

include

string

Optional

Inclusion

sort

string

Optional

Sorting

Includes:

Value

Description

country

Country Object

region

Region Object

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

Sorting:

Value

Sorts by:

name

City name field.

Examples#

http

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

curl

1curl -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

 1HTTP/2 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5     "data": [
 6         {
 7             "id": "dccb89ba-f777-4128-b99b-b25e19ccf4ea",
 8             "type": "cities",
 9             "attributes": {
10                 "name": "Aachen"
11             },
12             "relationships": {
13                 "country": {
14                     "links": {
15                         "self": "https://api.didww.com/v3/cities/dccb89ba-f777-4128-b99b-b25e19ccf4ea/relationships/country",
16                         "related": "https://api.didww.com/v3/cities/dccb89ba-f777-4128-b99b-b25e19ccf4ea/country"
17                     }
18                 },
19                 "region": {
20                     "links": {
21                         "self": "https://api.didww.com/v3/cities/dccb89ba-f777-4128-b99b-b25e19ccf4ea/relationships/region",
22                         "related": "https://api.didww.com/v3/cities/dccb89ba-f777-4128-b99b-b25e19ccf4ea/region"
23                     }
24                 }
25             }
26         }
27     ],
28     "meta": {
29         "total_records": 1,
30         "api_version": "2017-09-18"
31     },
32     "links": {
33         "first": "https://api.didww.com/v3/cities?page%5Bnumber%5D=1&page%5Bsize%5D=1000",
34         "last": "https://api.didww.com/v3/cities?page%5Bnumber%5D=2&page%5Bsize%5D=1000"
35     }
36 }

Other Responses#

Code

Success

Description

404

No

Not Found

401

No

Unauthorized