Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

Prefix the value with "ApiKey" to indicate the custom authorization type

Query Parameters

page
integer<int32>
default:1
Required range: x >= 1
size
integer<int32>
default:100
Required range: 1 <= x <= 100
name
string
regionCode
string

Response

Paginated list of regions

Standard paginated response wrapper used by all list endpoints. Use pageNumber and size to paginate; stop when pageNumber >= totalPages.

size
integer<int32>
required

Maximum number of items per page as requested

Example:

10

totalElements
integer<int64>
required

Total number of items matching the query across all pages

Example:

42

totalPages
integer<int32>
required

Total number of pages based on totalElements / size

Example:

5

pageNumber
integer<int32>
required

Current page number, 1-based (first page = 1)

Example:

1

data
any[]
required

Items in the current page; may be fewer than size on the last page