API Search endpoints…⌘K Get API credentialsGet access

Retrieve Client Details Template

GET/lokta-lms/api/v1/clients/template

Returns the field defaults and allowed values for creating a client.

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of:

Field Defaults
Allowed Value Lists

Example Request:

clients/template

Query parameters

officeIdquery · integer · int64 · optional

officeId

commandParamquery · string · optional

commandParam

staffInSelectedOfficeOnlyquery · boolean · optional

staffInSelectedOfficeOnly

Responses

200OK

Response fields

activationDatestring · date · optional
datatablesarray of GetClientsDataTables · optional
officeIdinteger · int64 · optional
officeOptionsarray of GetClientsOfficeOptions · optional
staffOptionsarray of GetClientsStaffOptions · 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