API Reference

Get Customers

Retrieve paginated list of customers using optional filters. Permission: Read Customers

Recipes
📱
Get most recent active loan with tags from Mobile Phone
Open Recipe
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
Defaults to page=5

The page number for paginated results. Defaults to 1. Used to traverse the paginated response

string
Defaults to sort=+createdAt

The field to sort results by. Prefix with '-' for descending order (e.g., '-createdAt'). Sortable fields are indicated in each field's description. Used to sort the response in ascending or descending order of an attribute

string
Defaults to createdAt=eq:2022-01-01

Filter expression in the format: filter[field][operator]=value. See individual field descriptions for available operators. Example: filter[status][eq]=Funded. Used to filter the response on an attribute value

string

The customer's preferred ACH processing method. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null, se, sw

string

The customer's date of birth. Use ISO 8601 date format (e.g., 2000-01-15). Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

boolean

Whether the customer has consented to phone contact. Sortable: Yes. Filter Operators: eq

boolean

Whether the customer has consented to SMS contact. Sortable: Yes. Filter Operators: eq

boolean

Whether the customer has consented to email marketing. Sortable: Yes. Filter Operators: eq

string

When the record was created. ISO 8601 datetime format (e.g., 2024-01-15T10:30:00Z). Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

string

When the customer's current bankruptcy was declared. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

string

The customer's preferred debit card processing method. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null, se, sw

string

The customer's preferred EFT processing method. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null, se, sw

string

The customer's email address. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null

string

The customer's ethnicity. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null, se, sw

string

An external identifier from a third-party system. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null, se, sw

string

The customer's eye color as recorded on identification. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null

string

The customer's first name. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null, se, sw

string

The customer's gender. Possible values: Female, Male. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null

string

The customer's height as recorded on identification. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null, se, sw

string

The customer's home ownership status. Possible values: Own, Rent, Other. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null

string

The customer's home phone number in E.164 format. Sortable: Yes. Filter Operators: eq, in, nin

integer

The internal database ID. Sortable: No. Filter Operators: eq, in, nin, ne, neq

string

The customer's government-issued ID number. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null, se, sw

string

The state that issued the customer's ID. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null, se, sw

string

The type of government-issued ID. Possible values: Drivers License, Passport, State ID, Student ID. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null

string

The company from which the customer record was imported. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null, se, sw

string

The date the customer was imported. Use ISO 8601 date format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

string

The source system from which the customer was imported. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null, se, sw

boolean

Whether the customer is active-duty military. Sortable: Yes. Filter Operators: eq

string

The last four digits of the customer's Social Security Number. Sortable: No. Filter Operators: eq, in, nin, neq

string

The customer's last name. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null, se, sw

string

The customer's marital status. Possible values: Divorced, Domestic Partnership, Married, Single, Widowed. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null

string

The customer's middle name. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null, sw

string

The customer's mobile phone number in E.164 format. Sortable: Yes. Filter Operators: eq, in, nin

string

The customer's mother's maiden name. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null

string

The customer's postal or ZIP code. Sortable: Yes. Filter Operators: eq, in

string

When the customer's previous bankruptcy was declared. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

string

When the customer's previous bankruptcy was dismissed. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

string

The date the customer record was purchased. Use ISO 8601 date format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

string

The customer's race. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null, se, sw

string

The customer's Social Security Number. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null, se, sw

string

The customer's spouse's email address. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null, se, sw

string

The customer's spouse's name. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null, se, sw

string

The customer's name suffix. Possible values: I, II, III, IV, V, VI, VII, VIII, Jr, Sr. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null

string

Tag names assigned to the customer. Sortable: No. Filter Operators: eq, sw, in, nin, ne, neq, nn, null

string

When the record was last updated. ISO 8601 datetime format (e.g., 2024-01-15T10:30:00Z). Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

string

The customer's unique identifier (UUID v4 format). Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

integer

The database ID of the user watching this customer. Sortable: No. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

integer

The customer's weight as recorded on identification. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, in, nin, ne, neq, nn, null

Headers
string
required
Defaults to application/vnd.totality.v1+json

Must be application/json.

string
required
Defaults to application/json

Must be application/json.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json