> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://apidocs.sare.africa/sare-core-api/identity/list-users/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://apidocs.sare.africa/_mcp/server. # List Users GET http://localhost:8080/api/v3/users Reference: https://apidocs.sare.africa/sare-core-api/identity/list-users ## Request ### Query parameters - `name` (string, optional) - `roleGroup` (string, optional) - `roleName` (string, optional) - `phoneNumber` (integer, optional) - `page` (integer, optional) - `size` (integer, optional) ### Headers - `Authorization` (string, optional) ## Response ### 200 200 OK - `code` (integer, optional) - `message` (string, optional) - `data` (UsersGetResponsesContentApplicationJsonSchemaData, optional) ## Types ### UsersGetResponsesContentApplicationJsonSchemaData - `content` (list of UsersGetResponsesContentApplicationJsonSchemaDataContentItems, optional) - `pageNumber` (integer, optional) - `size` (integer, optional) - `totalElements` (integer, optional) - `totalPages` (integer, optional) - `isLastPage` (boolean, optional) ### UsersGetResponsesContentApplicationJsonSchemaDataContentItems - `id` (string, optional) - `fullName` (string, optional) - `firstName` (string, optional) - `lastName` (string, optional) - `email` (string, optional) - `phone` (string, optional) - `identificationNumber` (string, optional) - `roles` (list of string, optional) - `isShofcoMember` (boolean, optional) - `shofcoId` (any, optional) ## Examples **Response** ```json { "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 } } ``` **SDK Code** ```python Identity_listUsers_example import requests url = "http://localhost:8080/api/v3/users" querystring = {"name":"Jane","page":"0","phoneNumber":"254712345678","roleGroup":"SALES","roleName":"SALES_AGENT","size":"20"} headers = {"Authorization": "Bearer {{accessToken}}"} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript Identity_listUsers_example const url = 'http://localhost:8080/api/v3/users?name=Jane&page=0&phoneNumber=254712345678&roleGroup=SALES&roleName=SALES_AGENT&size=20'; const options = {method: 'GET', headers: {Authorization: 'Bearer {{accessToken}}'}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Identity_listUsers_example package main import ( "fmt" "net/http" "io" ) func main() { url := "http://localhost:8080/api/v3/users?name=Jane&page=0&phoneNumber=254712345678&roleGroup=SALES&roleName=SALES_AGENT&size=20" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer {{accessToken}}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Identity_listUsers_example require 'uri' require 'net/http' url = URI("http://localhost:8080/api/v3/users?name=Jane&page=0&phoneNumber=254712345678&roleGroup=SALES&roleName=SALES_AGENT&size=20") http = Net::HTTP.new(url.host, url.port) request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer {{accessToken}}' response = http.request(request) puts response.read_body ``` ```java Identity_listUsers_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("http://localhost:8080/api/v3/users?name=Jane&page=0&phoneNumber=254712345678&roleGroup=SALES&roleName=SALES_AGENT&size=20") .header("Authorization", "Bearer {{accessToken}}") .asString(); ``` ```php Identity_listUsers_example request('GET', 'http://localhost:8080/api/v3/users?name=Jane&page=0&phoneNumber=254712345678&roleGroup=SALES&roleName=SALES_AGENT&size=20', [ 'headers' => [ 'Authorization' => 'Bearer {{accessToken}}', ], ]); echo $response->getBody(); ``` ```csharp Identity_listUsers_example using RestSharp; var client = new RestClient("http://localhost:8080/api/v3/users?name=Jane&page=0&phoneNumber=254712345678&roleGroup=SALES&roleName=SALES_AGENT&size=20"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer {{accessToken}}"); IRestResponse response = client.Execute(request); ``` ```swift Identity_listUsers_example import Foundation let headers = ["Authorization": "Bearer {{accessToken}}"] let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:8080/api/v3/users?name=Jane&page=0&phoneNumber=254712345678&roleGroup=SALES&roleName=SALES_AGENT&size=20")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```