Skip to main content
POST
Query zones

Authorizations

Authorization
string
header
required

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

Body

application/json

Body for POST /v1/zones/query.

ids and externalIds are optional and combined with OR. Omit both to page through every zone in the organization; a provided but empty list matches nothing.

ids
string[] | null

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

Example:
externalIds
string[] | null

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.

Example:
isDeleted
boolean
default:false

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

size
integer
default:100

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

offset
integer
default:0

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

Response

OK

Paginated zones, in created-at order. data items match GET /v1/zones/<id>.

data
ZoneDetailRead · object[]
required

Rows for this page, in a deterministic order.

meta
PageMeta · object
required

Pagination metadata.