Attributes

These attributes are Query Parameters with the filter operator prefix
Example endpoint - **/api/customers?mobilePhone=eq:8001234567 **

Multiple attributes can be used a single time to filter the data

Attribute	Type	Sort	Filter Operators
achProcessingPreference	string	✅	eq, in, nin, neq, nn, null, se
addressDetail	object	⛔
becameRefinanceEligibleAt	string date
birthdate	string date	✅	eq, gt, gte, lt, lte, neq
canBeContactedViaPhone	bool	✅
canBeContactedViaSms	bool	✅
canBeMarketedToViaEmail	bool	✅
createdAt	string date/time	✅	eq, gt, gte, lt, lte, neq
creditLimit	int	⛔
currentGamificationTierId	int	⛔
currentBankruptcyDeclaredAt	string date/time	✅	eq, gt, gte, lt, lte, neq, nn, null
customerId	int	⛔
debitCardProcessingPreference	string	✅	eq, neq, nn, null
email	string	⛔	eq, neq
ethnicity	string	✅	eq, in, nin, neq, nn, null, se
externalId	string	✅	eq, in, nin, neq, nn, null, se
eyeColor	string	✅	in, nin, neq, nn, null
firstName	string	⛔	eq, in, nin, neq, se
gender	string enum: "Female" "Male"	✅	eq, neq, nn, null
height	number as string	✅	eq, neq, nn, null
homeOwnershipStatus	string enum: "Own" "Other" "Rent"	✅	eq, neq, nn, null
homePhone	number as string	✅
identificationNumber	string	✅	eq, in, nin, neq, nn, null, se
identificationState	string	✅	eq, in, nin, neq, nn, null, se
identificationType	string enum: "Drivers License" "Passport" "State ID" "Student ID"	✅	eq, neq, nn, null
importCompany	string	⛔	eq, in, nin, neq, nn, null, se
importSource	string	✅	eq, in, nin, neq, nn, null, se
isEligibleForInstantFunding	bool	✅	eq
importedOn	string date	✅	eq, gt, gte, lt, lte, neq, nn, null
incomeSources	array of any
isMilitary	bool	✅
lastName	string	⛔	eq, in, nin, neq, se
loans	array of any
maritalStatus	string enum: "Divorced" "Domestic Partnership" "Married" "Single" "Widowed"	✅	eq, neq, nn, null
middleName	string	⛔	eq, in, nin, neq
mobilePhone	number as string	⛔
mothersMaidenName	string	✅	eq, in, nin, neq, nn, null
nextLoanGroupUuid	string	⛔
paymentProcessingTime	string time	✅	eq, neq, nn, null
postalCode	string	✅	❓
preferredContactTime	string enum:"Afternoon" "Anytime" "Evening" "Morning" "Noon"	✅	eq
preferredPhone	string enum:"Home" "Mobile" "Work"	✅	❓
previousBankruptcyDeclaredAt	string date/time	✅	eq, neq, nn, null
previousBankruptcyDismissedAt	string date/time	✅	eq, neq, nn, null
purchasedOn	string date	✅	eq, gt, gte, lt, lte, neq, nn, null
race	string	✅	eq, in ,nin, neq, nn, null, se
rccProcessingPreference	string	✅	eq, in ,nin, neq, nn, null, se
refinanceEligibleLoanUuids	array of string
revokedPaymentTypes	array
socialSecurityNumber	number as string	⛔	eq, neq, se
spouseEmail	string	✅	eq, in, nin, neq, nn, null, se
spouseName	string	✅	eq, in, nin, neq, nn, null, se
suffix	string enum:"I" "II" "III" "IV" "V" "VI" "VII" "VIII" "Jr" "Sr"	⛔	eq, neq, null
updatedAt	string date/time	⛔	eq, gt, gte, lt, lte, neq
uuid	string	✅	eq, neq
watchedByUserId	int	✅	eq, gt, gte, lt, lte, neq, nn, null
weight	int	✅	eq, gt, gte, lt, lte, neq, nn, null

200200

400400

401401

403403

422422

500500