# Get Areas

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

## Request

HTTP Method: `GET`

URI Path: `/v3/areas`

Note

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

### URI Query Parameters

| Name | Type | Is Required? | Description |
| --- | --- | --- | --- |
| include | `string` | No | [Inclusion](../../../specification/includes.html#api-includes) |
| filter[<filter\_name>] | `string` | No | [Filtering](../../../specification/filtering.html#api-filters) |
| fields[areas] | `string` | No | [Sparse fieldsets](../../../specification/sparse-fieldsets.html#api-sparse-fieldsets) |
| sort | `string` | No | [Sorting](../../../specification/sorting.html#api-sorting) |
| page[number] | `integer` | No | [Page number](../../../specification/pagination.html#api-pagination). |
| page[size] | `integer` | No | [Page size](../../../specification/pagination.html#api-pagination). Pagination defaults to `1000` records per page. The maximum is `1000`. |

### Includes

| Value | Description |
| --- | --- |
| country | [Country Object](../../coverage-resources/countries/country-object.html#country-object-v35) |

### Filters

| Filter Name | Type | Allow Blank | Allow Array | Filters by: |
| --- | --- | --- | --- | --- |
| id | `string` | No | Yes | Area `id` field. |
| name | `string` | Yes | Yes | Area `name` field. Case insensitive. |
| country.id | `string` | Yes | Yes | A `country.id` field. |

### Sorting

| Value | Sorts by: |
| --- | --- |
| name | Area `name` field. |

## Examples

Simple requestFilter by name or country.idInclude Country Resource

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/areas HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access token]
```

curl

```
1curl -i -X GET https://api.didww.com/v3/areas -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]"
```

response

```
 1HTTP/2 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5  "data": [
 6    {
 7      "id": "9fcc7390-84a2-47f1-a900-0558cdcb6ce3",
 8      "type": "areas",
 9      "attributes": {
10        "name": "Tuscany"
11      },
12      "relationships": {
13        "country": {
14          "links": {
15            "self": "https://api.didww.com/v3/areas/9fcc7390-84a2-47f1-a900-0558cdcb6ce3/relationships/country",
16            "related": "https://api.didww.com/v3/areas/9fcc7390-84a2-47f1-a900-0558cdcb6ce3/country"
17          }
18        }
19      }
20    }
21  ],
22   "meta": {
23       "total_records": 1,
24       "api_version": "2026-11-19"
25   },
26   "links": {
27       "first": "https://api.didww.com/v3/areas?page%5Bnumber%5D=1&page%5Bsize%5D=1000",
28       "last": "https://api.didww.com/v3/areas?page%5Bnumber%5D=1&page%5Bsize%5D=1000"
29   }
30}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/areas?filter%5Bname%5D=Tuscany&filter%5Bcountry.id%5D=3b11ad09-dc7e-451a-9d32-ae9c1604aaa8 HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access token]
```

curl

```
1curl -i -X GET 'https://api.didww.com/v3/areas?filter%5Bname%5D=Tuscany&filter%5Bcountry.id%5D=3b11ad09-dc7e-451a-9d32-ae9c1604aaa8' -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]"
```

response

```
 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5  "data": [
 6    {
 7      "id": "9fcc7390-84a2-47f1-a900-0558cdcb6ce3",
 8      "type": "areas",
 9      "attributes": {
10        "name": "Tuscany"
11      },
12      "relationships": {
13        "country": {
14          "links": {
15            "self": "https://api.didww.com/v3/areas/9fcc7390-84a2-47f1-a900-0558cdcb6ce3/relationships/country",
16            "related": "https://api.didww.com/v3/areas/9fcc7390-84a2-47f1-a900-0558cdcb6ce3/country"
17          }
18        }
19      }
20    }
21  ],
22  "meta": {
23      "total_records": 1,
24      "api_version": "2026-11-19"
25  },
26  "links": {
27      "first": "https://api.didww.com/v3/areas?filter%5Bcountry.id%5D=3b11ad09-dc7e-451a-9d32-ae9c1604aaa8&filter%5Bname%5D=Tuscany&page%5Bnumber%5D=1&page%5Bsize%5D=1000",
28      "last": "https://api.didww.com/v3/areas?filter%5Bcountry.id%5D=3b11ad09-dc7e-451a-9d32-ae9c1604aaa8&filter%5Bname%5D=Tuscany&page%5Bnumber%5D=1&page%5Bsize%5D=1000"
29  }
30}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/areas?include=country HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access token]
```

curl

```
1curl -i -X GET 'https://api.didww.com/v3/areas?include=country' -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]"
```

response

```
 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5  "data": [
 6    {
 7      "id": "9fcc7390-84a2-47f1-a900-0558cdcb6ce3",
 8      "type": "areas",
 9      "attributes": {
10        "name": "Tuscany"
11      },
12      "relationships": {
13        "country": {
14          "links": {
15            "self": "https://api.didww.com/v3/areas/9fcc7390-84a2-47f1-a900-0558cdcb6ce3/relationships/country",
16            "related": "https://api.didww.com/v3/areas/9fcc7390-84a2-47f1-a900-0558cdcb6ce3/country"
17          },
18          "data": {
19              "type": "countries",
20              "id": "51d3fe2a-6588-496b-870c-398e627de5c4"
21          }
22        }
23      }
24    }
25  ],
26  "included": [
27    {
28      "id": "51d3fe2a-6588-496b-870c-398e627de5c4",
29      "type": "countries",
30      "attributes": {
31        "name": "Italy",
32        "prefix": "39",
33        "iso": "IT"
34      },
35      "relationships": {
36        "regions": {
37          "links": {
38            "self": "https://api.didww.com/v3/countries/51d3fe2a-6588-496b-870c-398e627de5c4/relationships/regions",
39            "related": "https://api.didww.com/v3/countries/51d3fe2a-6588-496b-870c-398e627de5c4/regions"
40          }
41        }
42      }
43    }
44  ],
45  "meta": {
46      "total_records": 1,
47      "api_version": "2026-11-19"
48  },
49  "links": {
50      "first": "https://api.didww.com/v3/areas?include=country&page%5Bnumber%5D=1&page%5Bsize%5D=1000",
51      "last": "https://api.didww.com/v3/areas?include=country&page%5Bnumber%5D=1&page%5Bsize%5D=1000"
52  }
53}
```

[[DIDWW-API-EXAMPLE-END]]

## Other Responses

| Code | Success | Description |
| --- | --- | --- |
| 400 | No | [Bad Request](../../../specification/errors/index.html#api-bad-request). Malformed request: unknown filter, bad pagination or bad sort field. |
| 401 | No | [Unauthorized](../../authentication.html#authentication-v35) |
| 429 | No | The request budget of the account for the current window is spent (`too_many_requests`). `Retry-After` gives the number of seconds to wait. |
