Search Resources

GET/lokta-lms/api/v1/search

Searches loans, clients and other records for a text query, optionally limited to chosen resources.

Example Requests:

search?query=000000001

search?query=Petra&resource=clients,loans

search?query=Petra&resource=clients,loans&exactMatch=true

Query parameters

queryquery · string · optional

query

resourcequery · string · optional

resource

exactMatchquery · boolean · optional

exactMatch

Responses

200OK

Response fields

entityAccountNointeger · int64 · optional

entityExternalIdstring · optional

entityIdinteger · int64 · optional

entityNamestring · optional

entityOverduenumber · optional

Loans only: total overdue from the arrears aging, null elsewhere

entityStatusEnumOptionData · optional

entityTypestring · optional

parentIdinteger · int64 · optional

parentNamestring · 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.

This is the API reference for Lokta, the agentic loan servicing platform. Go to lokta.ai

import requests response = requests.get( "https://default.lokta.tech/lokta-lms/api/v1/search", auth=("{username}", "{password}"), headers={"Tenant-Identifier": "default"}, ) print(response.json())

const response = await fetch("https://default.lokta.tech/lokta-lms/api/v1/search", { 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("https://default.lokta.tech/lokta-lms/api/v1/search")) .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", "https://default.lokta.tech/lokta-lms/api/v1/search", 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))