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 Users Assigned To Area

||View as Markdown|

GET

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

GET

/api/v3/users/areas/:areaId

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

200Location_getUsersAssignedToArea_example

{
  "code": 200,
  "message": "Agents fetched successfully",
  "data": [
    {
      "id": "ua-8a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
      "userId": "f5c1d4e5-2a3b-4c5d-8e9f-0a1b2c3d4e5f",
      "firstName": "Jane",
      "lastName": "Doe",
      "fullName": "Jane Doe",
      "email": "jane@example.com",
      "phone": "254712345678",
      "areaId": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "areaName": "Kilimani"
    }
  ]
}

Path parameters

areaIdstringRequired

Headers

AuthorizationstringOptional

Response

200 OK

codeintegerOptional

messagestringOptional

datalist of objectsOptional

Was this page helpful?

Assign Users To Area

Unassign Users From Area

Sare Core API