List Areas

GET

http://localhost:8080/api/v3/areas

GET

/api/v3/areas

curl -G http://localhost:8080/api/v3/areas \
     -H "Authorization: Bearer {{accessToken}}" \
     -d deliveryAgentId=f5c1d4e5-2a3b-4c5d-8e9f-0a1b2c3d4e5f \
     -d name=Kilimani \
     -d page=0 \
     -d regionId=c2a1b3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5e \
     -d size=20

200Location_listAreas_example

{
  "code": 200,
  "message": "Areas",
  "data": {
    "content": [
      {
        "id": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
        "name": "Kilimani",
        "regionId": "c2a1b3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5e",
        "regionName": "Nairobi Central",
        "warehouseId": "w-01",
        "warehouseName": "Nairobi Warehouse",
        "fleetId": "f-01",
        "plateNumber": "KDA 123A",
        "countyId": "cty0a1b2-3c4d-4e5f-8a9b-0c1d2e3f4a5b",
        "countyName": "Nairobi",
        "salesAgentCount": 5,
        "subRegionName": "Kilimani Sub",
        "subRegionId": "d3b2c4e5-6f7a-4b8c-9d0e-1f2a3b4c5d6e"
      }
    ],
    "pageNumber": 1,
    "size": 20,
    "totalElements": 1,
    "totalPages": 1,
    "isLastPage": true
  }
}

Query parameters

namestringOptional

regionIdstringOptional

deliveryAgentIdstringOptional

pageintegerOptional

sizeintegerOptional

Response

200 OK

codeintegerOptional

messagestringOptional

dataobjectOptional

Headers

Query parameters

Response