List Users

GET

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

GET

/api/v3/users

curl -G http://localhost:8080/api/v3/users \
     -H "Authorization: Bearer {{accessToken}}" \
     -d name=Jane \
     -d page=0 \
     -d phoneNumber=254712345678 \
     -d roleGroup=SALES \
     -d roleName=SALES_AGENT \
     -d size=20

200Identity_listUsers_example

{
  "code": 200,
  "message": "Users fetched successfully",
  "data": {
    "content": [
      {
        "id": "f5c1d4e5-2a3b-4c5d-8e9f-0a1b2c3d4e5f",
        "fullName": "Jane Doe",
        "firstName": "Jane",
        "lastName": "Doe",
        "email": "jane.doe@sare.africa",
        "phone": "254712345678",
        "identificationNumber": "12345678",
        "roles": [
          "SALES_AGENT"
        ],
        "isShofcoMember": false
      }
    ],
    "pageNumber": 1,
    "size": 20,
    "totalElements": 1,
    "totalPages": 1,
    "isLastPage": true
  }
}

Query parameters

namestringOptional

roleGroupstringOptional

roleNamestringOptional

phoneNumberintegerOptional

pageintegerOptional

sizeintegerOptional

Response

200 OK

codeintegerOptional

messagestringOptional

dataobjectOptional

Headers

Query parameters

Response