List Clients

GET/lokta-lms/api/v1/clients

The list capability of clients can support pagination and sorting.

Example Requests:

clients

clients?fields=displayName,officeName,timeline

clients?offset=10&limit=50

clients?orderBy=displayName&sortOrder=DESC

Query parameters

officeIdquery · integer · int64 · optional

officeId

externalIdquery · string · optional

externalId

displayNamequery · string · optional

displayName

firstNamequery · string · optional

firstName

lastNamequery · string · optional

lastName

statusquery · string · optional

status

underHierarchyquery · string · optional

underHierarchy

offsetquery · integer · int32 · optional

offset

limitquery · integer · int32 · optional

limit

orderByquery · string · optional

orderBy

sortOrderquery · string · optional

sortOrder

orphansOnlyquery · boolean · optional

orphansOnly

legalFormquery · integer · int32 · optional

staffIdquery · integer · int64 · optional

staffId

Responses

200OK

Response fields

pageItemsarray of GetClientsPageItemsResponse · optional

totalFilteredRecordsinteger · int32 · 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", auth=("{username}", "{password}"), headers={"Tenant-Identifier": "default"}, ) print(response.json())

const response = await fetch("http://localhost:8080/lokta-lms/api/v1/clients", { 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")) .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", 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))