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>] |
|
No |
|
sort |
|
No |
Filters:
Filter Name |
Type |
Allow Blank |
Allow Array |
Filters by: |
---|---|---|---|---|
id |
|
No |
Yes |
Country |
name |
|
Yes |
Yes |
Country |
prefix |
|
Yes |
Yes |
Country |
iso |
|
Yes |
Yes |
Country |
is_available |
|
No |
No |
Indicates if DID numbers in the specified country are currently available for purchase. |
Sorting:
Value |
Sorts by |
---|---|
name |
Country |
prefix |
Country |
iso |
Country |
Fielding:
Value |
Returns |
---|---|
name |
Country |
prefix |
Country |
iso |
Country |
Example
GET /v3/countries HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]
curl -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"
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": [
{
"id": "9c56fe0f-eff0-4742-85f6-24868959344a",
"type": "countries",
"attributes": {
"name": "United Kingdom",
"prefix": "44",
"iso": "GB"
}
},
{
"id": "5d3d7640-16d2-4dc0-9aca-408789fbefc6",
"type": "countries",
"attributes": {
"name": "United States",
"prefix": "1",
"iso": "US"
}
}
]
}
Other Responses
Code |
Success |
Description |
---|---|---|
401 |
No |