Get all operation zones

GET 
/v1/operation-zones

Retrieve a paginated list of operation 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 operation zones retrieved successfully

application/json

Schema

Schema

data object[]required
The data of the paginated response
Array [
_id stringrequired
The ID of the operation zone
zoneName stringrequired
The name of the operation zone
currency objectrequired
The currency of the operation zone
iso stringrequired
The ISO of the currency
symbol stringrequired
The symbol of the currency
createdDate date-timerequired
The created date of the operation zone
dispatchRadius numberrequired
The dispatch radius of the operation zone
maxPickupRadius numberrequired
The max pickup radius of the operation zone
latestUpdate date-timerequired
The latest update date of the operation 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": "Operation Zone 1",
      "currency": {
        "iso": "USD",
        "symbol": "$"
      },
      "createdDate": "2025-01-01T00:00:00.000Z",
      "dispatchRadius": 1000,
      "maxPickupRadius": 1000,
      "latestUpdate": "2025-01-01T00:00:00.000Z"
    }
  ],
  "total": 100,
  "page": 1,
  "limit": 10,
  "totalPages": 10
}

Loading...