Get Customer Information

This request pulls customer information.

   Click here to learn more about this request

The Customers entity holds a vast amount of information. As such, we've added an $expand parameter to this request to allows you to view specific types of customer information. Here's what you need to know about this request:

  • There are several objects nested within the Customers entity. Each object can be expanded to display its information, and multiple objects can be expanded in a single request.
  • Here's a list of the objects nested within the Customers entity:
Object Description
CreditScore This holds a customer's credit score information from the three available credit reporting agencies.
CustomFieldValues This holds information for the custom fields associated with this customer.
Documents This holds information for the documents that have been associated with this customer.
Employer This holds information regarding the customer's employer.
Loans This holds information about the loans that are associated with this customer.
MailAddress This holds the customer's mailing address.
Notes This holds information for the notes that have been associated with this customer.
PaymentAccounts This holds the customer's payment profile information.
Phones This holds the customer's phone information.
PrimaryAddress This holds the customer's primary residency.
References This holds information regarding the customer's references.
SocialProfiles This holds the customer's social media profile information.

For an example of how customer information works within the UI, take a look at our Customer Overview article.

Database

For information regarding customer database tables, see the following articles:

Language
Authorization
Click Try It! to start a request and see the response here!