Get Regions
GET https://{{host}}/v3/regions
Returns a collection of Regions. Pagination is disabled.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
include | null | Comma-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 |
| filter[id] | null | | string - Filters by region id field.
-
Allow blank - No.
-
Allow array - Yes. | |
filter[name]| null | |string- Filters by region name field. Case insensitive. -
Allow blank - Yes.
-
Allow array - Yes. | |
filter[country.id]| null | |string- Filters by a country.id field. -
Allow blank - Yes.
-
Allow array - Yes. | |
sort| null | | Used for sorting the fields returned by the request, with a comma,separating the included fields. Details in Sorting Article.
name - Region name field.
*** |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string | ||
Content-Type | string | ||
Api-Key | string |
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"},"data":{"type":"countries","id":"fa914558-9c64-4e01-967b-3302bd65a97b"}}}}],"included":[{"id":"fa914558-9c64-4e01-967b-3302bd65a97b","type":"countries","attributes":{"name":"Canada","prefix":"1","iso":"CA"},"relationships":{"regions":{"links":{"self":"https://api.didww.com/v3/countries/24eb6e85-f628-4765-bbb2-420e48de76f2/relationships/regions","related":"https://api.didww.com/v3/countries/24eb6e85-f628-4765-bbb2-420e48de76f2/regions"}}}}],"meta":{"api_version":"2022-05-10"}}