API Search endpoints…⌘K Get API credentialsGet access

Retrieve Staff

GET/lokta-lms/api/v1/staff

Returns the list of staff members.

Example Requests:

  • /staff
  • /staff?status=ACTIVE
  • /staff?status=INACTIVE
  • /staff?status=ALL

By default it Returns all the ACTIVE Staff. Otherwise a status can be provided like e.g. status=INACTIVE,
then it returns all INACTIVE staff or status=ALL returns both ACTIVE and INACTIVE staff.

Query parameters

officeIdquery · integer · int64 · optional

officeId

staffInOfficeHierarchyquery · boolean · optional

staffInOfficeHierarchy

loanOfficersOnlyquery · boolean · optional

loanOfficersOnly

statusquery · string · optional

status

Responses

defaultdefault response

Response fields

allowedOfficesarray of OfficeData · optional
dateFormatstring · optional
displayNamestring · optional
externalIdstring · optional
firstnamestring · optional
idinteger · int64 · optional
isActiveboolean · optional
isLoanOfficerboolean · optional
joiningDatestring · date · optional
lastnamestring · optional
localestring · optional
mobileNostring · optional
officeIdinteger · int64 · optional
officeNamestring · optional
rowIndexinteger · 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.

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