Get Customer Custom Field Values

This request pulls a customer profile's current Custom Field values.

   Click here to learn more about this request

Custom Fields are used by lenders to track information that applies to their business but isn't native to LoanPro. Custom Fields are created and stored within the environment settings and then can be applied to entities such as customers, installment loans, line of credit accounts, and more. To learn the basics of Custom Fields, see Intro to Custom Fields ↗

Here is what's needed to know about this request:

• This request pulls the values of all Custom Fields that have been applied to a customer profile. The CustomFieldValues object holds Custom Field information, and it's nested within the Customers entity.
• The response of this request lists each Custom Field that has been applied to the customer profile. Here's a breakdown of the information listed in each result:
  • "id" : The ID that represents the Custom Field as it's applied to the customer profile. This ID is what's used when updating a customer Custom Field value.
  • "entityId" : The ID of the entity that the Custom Field is associated with. In this context, this is the ID of the customer profile.
  • "entityType" : The type of the entity that the Custom Field is associated with. In this context, this is the ID of the customer profile.
  • "customFieldId" : The ID of the Custom Field configuration that applies broadly to the tenant account.
  • "customFieldValue" : The current value that's stored within the Custom Field for this customer profile.

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

Database

For information regarding 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 – Customer Main Table (customer_entity)