Get Countries#

Description

Returns a list of countries. Pagination is disabled.

Request#

HTTP Method: GET

URI Path: /v3/countries

URI Query Parameters:

Name

Type

Is Required?

Description

filter[<filter_name>]

string, boolean

Optional

Filtering

sort

string

Optional

Sorting

Filters:

Filter Name

Type

Allow Blank

Allow Array

Filters by:

id

string

No

Yes

Country id field.

name

string

Yes

Yes

Country name field. Case insensitive.

prefix

string

Yes

Yes

Country prefix field.

iso

string

Yes

Yes

Country iso field.

is_available

boolean

No

No

Indicates if DID numbers in the specified country are currently available for purchase

Sorting:

Value

Sorts by:

name

Country name field

prefix

Country prefix field

iso

Country iso field

Example#

http

1GET /v3/countries 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/countries -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"

response

 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5     "data": [
 6         {
 7             "id": "9c56fe0f-eff0-4742-85f6-24868959344a",
 8             "type": "countries",
 9             "attributes": {
10                 "name": "United Kingdom",
11                 "prefix": "44",
12                 "iso": "GB"
13             },
14             "relationships": {
15                 "regions": {
16                     "links": {
17                         "self": "https://api.didww.com/v3/countries/9c56fe0f-eff0-4742-85f6-24868959344a/relationships/regions",
18                         "related": "https://api.didww.com/v3/countries/9c56fe0f-eff0-4742-85f6-24868959344a/regions"
19                     }
20                 }
21             }
22         },
23         {
24             "id": "5d3d7640-16d2-4dc0-9aca-408789fbefc6",
25             "type": "countries",
26             "attributes": {
27                 "name": "United States",
28                 "prefix": "1",
29                 "iso": "US"
30             },
31             "relationships": {
32                 "regions": {
33                     "links": {
34                         "self": "https://api.didww.com/v3/countries/5d3d7640-16d2-4dc0-9aca-408789fbefc6/relationships/regions",
35                         "related": "https://api.didww.com/v3/countries/5d3d7640-16d2-4dc0-9aca-408789fbefc6/regions"
36                     }
37                 }
38             }
39         }
40     ],
41     "meta": {
42         "api_version": "2017-09-18"
43     }
44 }

Other Responses#

Code

Success

Description

401

No

Unauthorized