Get Region

GET https://{{host}}/v3/regions/:id

Returns a single Region.

Request Params

KeyDatatypeRequiredDescription
includenullComma-separated values of include parameter.
The response will include a top-level object relationships with associated data under the appropriate resource key.
Details in Inclusion of Related Resources Article.

Allowed values:

country - Country Object |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring
Content-Typestring
Api-Keystring

RESPONSES

status: OK

{"data":{"id":"8ce33ee2-73da-4baa-85a0-cd607d0e9733","type":"regions","attributes":{"name":"Alberta"},"relationships":{"country":{"links":{"self":"https://api.didww.com/v3/regions/8ce33ee2-73da-4baa-85a0-cd607d0e9733/relationships/country","related":"https://api.didww.com/v3/regions/8ce33ee2-73da-4baa-85a0-cd607d0e9733/country"}}}},"included":[{"id":"fa914558-9c64-4e01-967b-3302bd65a97b","type":"countries","attributes":{"name":"Canada","prefix":"1","iso":"CA"}}],"meta":{"api_version":"2022-05-10"}}