Get Region#
Returns a single Region.
Request#
HTTP Method: GET
URI Path: /v3/regions/{id}
Note
For all returned data attributes, see Region Object.
URI Query Parameters#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
id |
|
Yes |
Unique ID identifier for the Region |
include |
|
No |
Includes#
Value |
Description |
|---|---|
country |
Examples#
http
1GET /v3/regions/8ce33ee2-73da-4baa-85a0-cd607d0e9733 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/8ce33ee2-73da-4baa-85a0-cd607d0e9733 -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 "id": "8ce33ee2-73da-4baa-85a0-cd607d0e9733",
7 "type": "regions",
8 "attributes": {
9 "name": "Alberta",
10 "iso": "CA-AB"
11 },
12 "relationships": {
13 "country": {
14 "links": {
15 "self": "https://api.didww.com/v3/regions/8ce33ee2-73da-4baa-85a0-cd607d0e9733/relationships/country",
16 "related": "https://api.didww.com/v3/regions/8ce33ee2-73da-4baa-85a0-cd607d0e9733/country"
17 }
18 }
19 }
20 },
21 "meta": {
22 "api_version": "2026-11-19"
23 }
24}
http
1GET /v3/regions/8ce33ee2-73da-4baa-85a0-cd607d0e9733?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/8ce33ee2-73da-4baa-85a0-cd607d0e9733?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 "id": "8ce33ee2-73da-4baa-85a0-cd607d0e9733",
7 "type": "regions",
8 "attributes": {
9 "name": "Alberta",
10 "iso": "CA-AB"
11 },
12 "relationships": {
13 "country": {
14 "links": {
15 "self": "https://api.didww.com/v3/regions/8ce33ee2-73da-4baa-85a0-cd607d0e9733/relationships/country",
16 "related": "https://api.didww.com/v3/regions/8ce33ee2-73da-4baa-85a0-cd607d0e9733/country"
17 },
18 "data": {
19 "type": "countries",
20 "id": "fa914558-9c64-4e01-967b-3302bd65a97b"
21 }
22 }
23 }
24 },
25 "included": [
26 {
27 "id": "fa914558-9c64-4e01-967b-3302bd65a97b",
28 "type": "countries",
29 "attributes": {
30 "name": "Canada",
31 "prefix": "1",
32 "iso": "CA"
33 },
34 "relationships": {
35 "regions": {
36 "links": {
37 "self": "https://api.didww.com/v3/countries/fa914558-9c64-4e01-967b-3302bd65a97b/relationships/regions",
38 "related": "https://api.didww.com/v3/countries/fa914558-9c64-4e01-967b-3302bd65a97b/regions"
39 }
40 }
41 }
42 }
43 ],
44 "meta": {
45 "api_version": "2026-11-19"
46 }
47}
Other Responses#
Code |
Success |
Description |
|---|---|---|
404 |
No |
|
401 |
No |
|
429 |
No |
The request budget of the account for the current window is spent ( |