# Retrieve Loan Details Template

`GET /lokta-lms/api/v1/loans/template`

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 description Lists
Example Requests:

loans/template?templateType=individual&clientId=1


loans/template?templateType=individual&clientId=1&productId=1

## Parameters
- `clientId` (query, integer): clientId
- `groupId` (query, integer): groupId
- `productId` (query, integer): productId
- `templateType` (query, string): templateType
- `staffInSelectedOfficeOnly` (query, boolean): staffInSelectedOfficeOnly
- `activeOnly` (query, boolean): activeOnly

## Responses
- `200`: OK

## Response fields
- `clientId` (integer)
- `clientName` (string)
- `clientOfficeId` (integer)
- `productOptions` (array of GetLoansTemplateProductOptions)
- `timeline` (GetLoansTemplateTimeline)

## Example request (cURL)
```bash
curl -X GET \
  'http://localhost:8080/lokta-lms/api/v1/loans/template' \
  -u '{username}:{password}' \
  -H 'Tenant-Identifier: default'
```

## Example response
```json
{
  "clientId": 1,
  "clientName": "Kampala first Client",
  "clientOfficeId": 2,
  "productOptions": [
    {}
  ]
}
```

Interactive: https://developer.lokta.ai/reference.html#operation/retrieveTemplateLoan
