List Regions

GET

http://localhost:8080/api/v3/regions

GET

/api/v3/regions

curl -G http://localhost:8080/api/v3/regions \
     -H "Authorization: Bearer {{accessToken}}" \
     -d countyId=cty0a1b2-3c4d-4e5f-8a9b-0c1d2e3f4a5b \
     --data-urlencode "name=Nairobi Central" \
     -d page=0 \
     -d size=20

200Location_listRegions_example

{
  "code": 200,
  "message": "Regions",
  "data": {
    "content": [
      {
        "id": "c2a1b3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5e",
        "name": "Nairobi Central",
        "countyId": "cty0a1b2-3c4d-4e5f-8a9b-0c1d2e3f4a5b",
        "countyName": "Nairobi",
        "areaCount": 4,
        "subRegionCount": 2,
        "cutOffTime": "18:45",
        "salesManagers": [
          {
            "id": "f5c1d4e5-2a3b-4c5d-8e9f-0a1b2c3d4e5f",
            "name": "Jane Doe"
          }
        ]
      }
    ],
    "pageNumber": 1,
    "size": 20,
    "totalElements": 1,
    "totalPages": 1,
    "isLastPage": true
  }
}

Query parameters

namestringOptional

countyIdstringOptional

pageintegerOptional

sizeintegerOptional

Response

200 OK

codeintegerOptional

messagestringOptional

dataobjectOptional

Headers

Query parameters

Response