For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Skip to navigation

Sare Core API Location

Get Area

||View as Markdown|

GET

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

GET

/api/v3/areas/:id

curl http://localhost:8080/api/v3/areas/a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d \
     -H "Authorization: Bearer {{accessToken}}"

{
  "code": 200,
  "message": "Area",
  "data": {
    "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"
  }
}

Path parameters

idstringRequired

Headers

AuthorizationstringOptional

Response

200 OK

codeintegerOptional

messagestringOptional

dataobjectOptional

Errors

404

Not Found Error

Was this page helpful?

Sare Core API