Get loan settings Custom Fields

This request allows you to retrieve Custom Field information for a loan's settings.

   Click here to learn more about this request

Custom fields are used by lenders to track information that's important to their business practices but isn't native to LoanPro. Note the following when making this request:

The CustomFieldValues object is nested within the LoanSettings entity in this context.

This request will retrieve information about all of the custom fields associated with the custom fields on a loan. The response will include the following information:

id : this is the database ID of the custom field

entityId: in this context, this is the ID of the loan setting

customFieldId: this is the system ID of the custom field

customFieldValue: this is the current value of the custom field

For an example of how customer custom fields work within the UI, take a look at our Custom Fields article.

Database

For information on customer and custom field database tables, see the following articles:

Database – Custom Field Entity (custom_field)

Database – Custom Field to Entity Map (custom_field__entity)

Database – Loan Settings Entity (loan_settings_entity)

Path Params
int32
required

This is the ID of the associated loan.

Query Params
string
Defaults to LoanSettings/CustomFieldValues

To pull loan settings custom field information, you'll need to use an expand token.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json