Skip to main content
GET
/
api
/
v2
/
platform
/
zones
/
{id}
Return a Zone
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://{defaultHost}/api/v2/platform/zones/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "data": {
    "id": "118",
    "type": "zone",
    "attributes": {
      "name": "Molestiae esse ab labore ratione nemo.",
      "description": "Impedit vitae in modi quaerat qui quod quia.",
      "default_tax": false,
      "zone_members_count": 0,
      "created_at": "2022-11-08T19:36:10.198Z",
      "updated_at": "2022-11-08T19:36:10.198Z",
      "kind": "state"
    },
    "relationships": {
      "zone_members": {
        "data": []
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Query Parameters

​
include
string

Select which associated resources you would like to fetch, see: https://jsonapi.org/format/#fetching-includes

Response

Record found

​
data
object
required