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 |
|
No |
|
filter[<filter_name>] |
|
No |
|
fields[regions] |
|
No |
|
sort |
|
No |
Includes#
Value |
Description |
|---|---|
country |
Filters#
Filter Name |
Type |
Allow Blank |
Allow Array |
Filters by: |
|---|---|---|---|---|
id |
|
No |
Yes |
Region |
name |
|
Yes |
Yes |
Region |
country.id |
|
Yes |
Yes |
A |
iso |
|
No |
Yes |
Region |
Sorting#
Value |
Sort by |
|---|---|
name |
Region |
iso |
Region |
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}
http
1GET /v3/regions?filter%5Bcountry.id%5D=3b11ad09-dc7e-451a-9d32-ae9c1604aaa8&sort=-name 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?filter%5Bcountry.id%5D=3b11ad09-dc7e-451a-9d32-ae9c1604aaa8&sort=-name' -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": "525dab52-0f4b-43cb-b1f6-83ee97a0b5ff",
8 "type": "regions",
9 "attributes": {
10 "name": "Wyoming",
11 "iso": "US-WY"
12 },
13 "relationships": {
14 "country": {
15 "links": {
16 "self": "https://api.didww.com/v3/regions/525dab52-0f4b-43cb-b1f6-83ee97a0b5ff/relationships/country",
17 "related": "https://api.didww.com/v3/regions/525dab52-0f4b-43cb-b1f6-83ee97a0b5ff/country"
18 }
19 }
20 }
21 }
22 ],
23 "meta": {
24 "api_version": "2026-11-19"
25 }
26}
http
1GET /v3/regions?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/regions?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": "8ce33ee2-73da-4baa-85a0-cd607d0e9733",
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/8ce33ee2-73da-4baa-85a0-cd607d0e9733/relationships/country",
17 "related": "https://api.didww.com/v3/regions/8ce33ee2-73da-4baa-85a0-cd607d0e9733/country"
18 },
19 "data": {
20 "type": "countries",
21 "id": "fa914558-9c64-4e01-967b-3302bd65a97b"
22 }
23 }
24 }
25 }
26 ],
27 "included": [
28 {
29 "id": "fa914558-9c64-4e01-967b-3302bd65a97b",
30 "type": "countries",
31 "attributes": {
32 "name": "Canada",
33 "prefix": "1",
34 "iso": "CA"
35 },
36 "relationships": {
37 "regions": {
38 "links": {
39 "self": "https://api.didww.com/v3/countries/fa914558-9c64-4e01-967b-3302bd65a97b/relationships/regions",
40 "related": "https://api.didww.com/v3/countries/fa914558-9c64-4e01-967b-3302bd65a97b/regions"
41 }
42 }
43 }
44 }
45 ],
46 "meta": {
47 "api_version": "2026-11-19"
48 }
49}
Other Responses#
Code |
Success |
Description |
|---|---|---|
400 |
No |
|
401 |
No |
|
429 |
No |
The request budget of the account for the current window is spent ( |