# Get Countries

Returns a list of countries. [Pagination](../../../specification/pagination.html#api-pagination) is disabled.

## Request

HTTP Method: `GET`

URI Path: `/v3/countries`

Note

For all returned data attributes, see [Country Object](country-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[countries] | `string` | No | [Sparse fieldsets](../../../specification/sparse-fieldsets.html#api-sparse-fieldsets) |
| sort | `string` | No | [Sorting](../../../specification/sorting.html#api-sorting) |

### Includes

| Value | Description |
| --- | --- |
| regions | [Region Object](../regions/region-object.html#region-object-v34) |

### Filters

| Filter Name | Type | Allow Blank | Allow Array | Filters by: |
| --- | --- | --- | --- | --- |
| id | `string` | No | Yes | Country `id` field. |
| name | `string` | Yes | Yes | Country `name` field. |
| 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

[[DIDWW-API-EXAMPLE-START]]

http

```
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

```
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"
```

response

```
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"
         }
     }
     ]
}
```

[[DIDWW-API-EXAMPLE-END]]

## Other Responses

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

On this page