Get all flat zones

GET 
/v1/flat-zones

Retrieve a paginated list of flat zones with optional name filtering

Request

Query Parameters

page number

Possible values: >= 1

Default value: 1

Page number for pagination

limit number

Possible values: >= 1

Default value: 10

Number of items per page

name string

Filter by zone name (case-insensitive)

Responses

200

List of flat zones retrieved successfully

application/json

Schema

Schema

data object[]required
The data of the paginated response
Array [
_id stringrequired
The ID of the flat zone
zoneName stringrequired
The name of the flat zone
createdDate date-timerequired
The creation date of the flat zone
latestUpdate date-timerequired
The latest update date of the flat zone
]
total numberrequired

The total number of items

page numberrequired

The current page

limit numberrequired

The number of items per page

totalPages numberrequired

The total number of pages

Example (from schema)

{
  "data": [
    {
      "_id": "672d07188234567890123456",
      "zoneName": "Flat Zone 1",
      "createdDate": "2021-01-01",
      "latestUpdate": "2021-01-01"
    }
  ],
  "total": 100,
  "page": 1,
  "limit": 10,
  "totalPages": 10
}

Loading...