Get Regions#

Returns a collection of Regions. Pagination is disabled.

Request#

HTTP Method: GET

URI Path: /v3/regions

Note

For all returned data attributes, see Region Object.

URI Query Parameters#

Name

Type

Is Required?

Description

include

string

No

Inclusion

filter[<filter_name>]

string

No

Filtering

fields[regions]

string

No

Sparse fieldsets

sort

string

No

Sorting

Includes#

Value

Description

country

Country Object

Filters#

Filter Name

Type

Allow Blank

Allow Array

Filters by:

id

string

No

Yes

Region id field.

name

string

Yes

Yes

Region name field. Case insensitive.

country.id

string

Yes

Yes

A country.id field.

iso

string

No

Yes

Region iso field.

Sorting#

Value

Sort by

name

Region name field.

iso

Region iso field.

Examples#

http

1GET /v3/regions 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/regions -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": "e2f3f115-11f1-43cf-8279-08b29d94403d",
 8      "type": "regions",
 9      "attributes": {
10        "name": "Alberta",
11        "iso": "CA-AB"
12      },
13      "relationships": {
14        "country": {
15          "links": {
16            "self": "https://api.didww.com/v3/regions/e2f3f115-11f1-43cf-8279-08b29d94403d/relationships/country",
17            "related": "https://api.didww.com/v3/regions/e2f3f115-11f1-43cf-8279-08b29d94403d/country"
18          }
19        }
20      }
21    }
22  ],
23  "meta": {
24    "api_version": "2026-11-19"
25  }
26}

Other Responses#

Code

Success

Description

400

No

Bad Request

401

No

Unauthorized

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.