List Geozones
GET
/api/v2/geozones.json
Get or search for one or more Geozones.
Scopes
Requires either the geozones or geozones.readonly OAuth scope.
Query Parameters
Accepts the following query parameters:
id:in
Return Geozones by a comma-separated list of IDs. |
title
Used to find a single Geozone by its |
JSON response
Evance will return a JSON object containing the following properties:
success
A successful search request containing zero or more results will always return a true value.
|
status
An integer matching the HTTP response code. A successful request will have a status of 200.
|
data
An array containing zero or more Geozone data objects. |
pagination
Search results include a pagination object contain information about the current page, total pages, the limit per page and the total number of results available.
|
links
An object containing links to traverse available search results.
|
Example response
In the example below you're able to see examples of geozones.
{
"success": true,
"status": 200,
"data": [
{
"id": 48646,
"title": "East Anglia - UK",
"description": "All counties in East Anglia, United Kingdom",
"createdOn": "2022-05-21T15:54:05+00:00"
"modifiedOn": "2022-05-21T15:54:05+00:00",
"countries": [
{
"countryCode": "GB",
"regionsCodes": ["GB-SFK", "GB-NFK", "GB-CAM"]
}
]
}, {
"id": 52367,
"title": "Northern America",
"description": "Countries in Northern America",
"createdOn": "2022-05-21T15:54:05+00:00"
"modifiedOn": "2022-05-21T15:54:05+00:00",
"countries": [
{
"countryCode": "CA",
"regionsCodes": []
},
{
"countryCode": "MX",
"regionsCodes": []
},
{
"countryCode": "US",
"regionsCodes": []
}
]
}
],
"pagination": {
"page": 1,
"limit": 100,
"total": 1,
"totalPages": 1
},
"links": {
"self": "https://examples.evance.me/api/v2/geozones.json",
"previous": null,
"next": null
}
}