Returns a list of Zones
curl --request GET \
--url http://{defaultHost}/api/v2/platform/zones \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "113",
"type": "zone",
"attributes": {
"name": "Laudantium itaque ab suscipit quo fugit delectus perferendis.",
"description": "Cum nisi esse veniam explicabo praesentium quod reprehenderit.",
"default_tax": false,
"zone_members_count": 0,
"created_at": "2022-11-08T19:36:09.411Z",
"updated_at": "2022-11-08T19:36:09.411Z",
"kind": "state"
},
"relationships": {
"zone_members": {
"data": []
}
}
},
{
"id": "114",
"type": "zone",
"attributes": {
"name": "Enim perferendis consectetur in assumenda dolor deserunt.",
"description": "Incidunt iusto vitae architecto nulla voluptate.",
"default_tax": false,
"zone_members_count": 0,
"created_at": "2022-11-08T19:36:09.412Z",
"updated_at": "2022-11-08T19:36:09.412Z",
"kind": "state"
},
"relationships": {
"zone_members": {
"data": []
}
}
}
],
"meta": {
"count": 2,
"total_count": 2,
"total_pages": 1
},
"links": {
"self": "http://www.example.com/api/v2/platform/zones?page=1&per_page=&include=&filter[description_eq]=",
"next": "http://www.example.com/api/v2/platform/zones?filter%5Bdescription_eq%5D=&include=&page=1&per_page=",
"prev": "http://www.example.com/api/v2/platform/zones?filter%5Bdescription_eq%5D=&include=&page=1&per_page=",
"last": "http://www.example.com/api/v2/platform/zones?filter%5Bdescription_eq%5D=&include=&page=1&per_page=",
"first": "http://www.example.com/api/v2/platform/zones?filter%5Bdescription_eq%5D=&include=&page=1&per_page="
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>
Records returned
The response is of type object
.
Was this page helpful?
curl --request GET \
--url http://{defaultHost}/api/v2/platform/zones \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "113",
"type": "zone",
"attributes": {
"name": "Laudantium itaque ab suscipit quo fugit delectus perferendis.",
"description": "Cum nisi esse veniam explicabo praesentium quod reprehenderit.",
"default_tax": false,
"zone_members_count": 0,
"created_at": "2022-11-08T19:36:09.411Z",
"updated_at": "2022-11-08T19:36:09.411Z",
"kind": "state"
},
"relationships": {
"zone_members": {
"data": []
}
}
},
{
"id": "114",
"type": "zone",
"attributes": {
"name": "Enim perferendis consectetur in assumenda dolor deserunt.",
"description": "Incidunt iusto vitae architecto nulla voluptate.",
"default_tax": false,
"zone_members_count": 0,
"created_at": "2022-11-08T19:36:09.412Z",
"updated_at": "2022-11-08T19:36:09.412Z",
"kind": "state"
},
"relationships": {
"zone_members": {
"data": []
}
}
}
],
"meta": {
"count": 2,
"total_count": 2,
"total_pages": 1
},
"links": {
"self": "http://www.example.com/api/v2/platform/zones?page=1&per_page=&include=&filter[description_eq]=",
"next": "http://www.example.com/api/v2/platform/zones?filter%5Bdescription_eq%5D=&include=&page=1&per_page=",
"prev": "http://www.example.com/api/v2/platform/zones?filter%5Bdescription_eq%5D=&include=&page=1&per_page=",
"last": "http://www.example.com/api/v2/platform/zones?filter%5Bdescription_eq%5D=&include=&page=1&per_page=",
"first": "http://www.example.com/api/v2/platform/zones?filter%5Bdescription_eq%5D=&include=&page=1&per_page="
}
}