v1

latestOpenAPI 3.1.02026-07-2296226496.3 KB

Zones

Query zones

Return full zone details for many zones in a single call. Filter by ids and/or externalIds (combined with OR); omit both to page through all of the organization's zones. Results come back under data with pagination under meta; each data item matches the shape of GET /v1/zones/<id>.

post/v1/zones/query

Request body

idsstring[] nullable

Nash zone ids to fetch (max 500). Combined with externalIds using OR. Omit to not filter by id; an empty list matches nothing.

externalIdsstring[] nullable

Your external zone ids to fetch (max 500). Combined with ids using OR. Omit to not filter by external id; an empty list matches nothing.

isDeletedboolean

When true, return soft-deleted zones instead of active ones.

sizeinteger

Page size, 1 to 500. Requests above 500 return a ZONE_BULK_LIMIT_EXCEEDED error.

offsetinteger

Number of zones to skip, for paging through the full result set.

Example request

{
  "externalIds": [
    "7810BBTORQ",
    "7810BBWAUR"
  ],
  "isDeleted": false,
  "offset": 0,
  "size": 100
}

Response

Example response

{
  "meta": {
    "total": 137,
    "size": 100
  }
}