Retrieve a Client

GET/lokta-lms/api/v1/clients/{clientId}

Example Requests:

clients/1

clients/1?template=true

clients/1?fields=id,displayName,officeName

Path parameters

clientIdpath · integer · int64 · required

clientId

Query parameters

staffInSelectedOfficeOnlyquery · boolean · optional

staffInSelectedOfficeOnly

Responses

200OK

Response fields

accountNostring · optional

activationDatestring · date · optional

activeboolean · optional

displayNamestring · optional

emailAddressstring · optional

externalIdstring · optional

firstnamestring · optional

groupsarray of GetClientsGroups · optional

idinteger · int64 · optional

lastnamestring · optional

officeIdinteger · int64 · optional

officeNamestring · optional

savingsProductIdinteger · int64 · optional

savingsProductNamestring · optional

statusGetClientsClientIdStatus · optional

timelineGetClientsTimeline · optional

Every request authenticates with HTTP Basic and carries a Tenant-Identifier header. See the conventions for dates, commands, pagination and errors. Open this operation in the interactive explorer, or read it as Markdown.

import requests response = requests.get( "http://localhost:8080/lokta-lms/api/v1/clients/{clientId}", auth=("{username}", "{password}"), headers={"Tenant-Identifier": "default"}, ) print(response.json())

const response = await fetch("http://localhost:8080/lokta-lms/api/v1/clients/{clientId}", { method: "GET", headers: { Authorization: "Basic " + Buffer.from("{username}:{password}").toString("base64"), "Tenant-Identifier": "default", }, }); console.log(await response.json());

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("http://localhost:8080/lokta-lms/api/v1/clients/{clientId}")) .header("Authorization", "Basic " + Base64.getEncoder().encodeToString("{username}:{password}".getBytes())) .header("Tenant-Identifier", "default") .method("GET", HttpRequest.BodyPublishers.noBody()) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

req, _ := http.NewRequest("GET", "http://localhost:8080/lokta-lms/api/v1/clients/{clientId}", nil) req.SetBasicAuth("{username}", "{password}") req.Header.Set("Tenant-Identifier", "default") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() data, _ := io.ReadAll(res.Body) fmt.Println(string(data))