Skip to main content
GET
List regions

Authorizations

Authorization
string
header
required

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

Query Parameters

filter[available]
object

Allows filtering by available using one or more operators.

filter[private]
object

Allows filtering by private using one or more operators.

filter[zone]
object

Allows filtering by zone using one or more operators.

page[size]
integer

Determines the number of items to show.

Required range: 1 <= x <= 100
page[before]
string

Pagination cursor. This is automatically generated as necessary and provided in HAL links (_links); it should not be constructed externally.

page[after]
string

Pagination cursor. This is automatically generated as necessary and provided in HAL links (_links); it should not be constructed externally.

sort
string

Allows sorting by a single field.
Use a dash ("-") to sort descending.
Supported fields: id, created_at, updated_at.

Example:

"-updated_at"

Response

OK

count
integer

Total number of items across pages.

regions
object[]
Last modified on June 16, 2026