Available Operators

eq equal to
gt greater than
gte greater than or equal to
in in
nin not in
lt less than
lte less than or equal to
neq not equal to
se string equal to
nn not null
null null

Not suffixing the fields that have multiple filter conditions will result in unexpected results. Each filter must be prefixed with one of the above-listed operators. Filter criteria may only be omitted when using the nn, null operators: ?loanUuid=nn&customerUuid=null
When specifying multiple conditions for a single field, suffix the fields with brackets:
?creditLimit[]=gt:10000&creditLimit[]=lt:20000
When using in and nin operations use commas to separate multiple values:
firstName=in:Mike,Ryan,Anthony

Examples:

String Fields

Attributes of this type are generally limited to eq, in, nin, neq, nn, & null operators.

String

country=eq:United States: get data objects with country equal to United States.
city=neq:Arlington%20Heights: get data objects where city is not equal to Arlington Heights.

Number as String

socialSecurityNumber=eq:100-55-4034: get data object with social security number.
workPhone=neq:7168455233: get data object with out this work phone number.

String UUID

uuid=eq:3da1827f-0c87-4c51-828d-a8cb7e30fd85: find a specific data object.
loanGroupUuid=neq:3da1827f-0c87-4c51-828d-a8cb7e30fd85: get all data objects that do not belong to a specific loan group.

String link

reportUrl=nn: get all data objects that are not equal to null.

Numeric Fields

Attributes of this type are generally limited to eq, gt, gte, lt, lte, neq, nn, & null operators.

Int

amount=gt:500: get all data objects that have an amount greater than $500.
amount=neq:0: get all data objects that are not for a zero-dollar amount.
fees=nn: get all data objects that have fees.

String as int

leadExternalId=eq:1270166539: get lead with an External ID equal to 1270166539.

Date Fields

Attributes of this type are generally limited to eq, gt, gte, lt, lte operators.

String Date/Time

appliedAt=eq:2022-03-10T22:29:47: get all data objects applied at March 10, 2020 at 10:29:47pm.
createdAt[]=gt:2020-01-01T00:00:00&createdAt[]=lt:2020-02-01T00:00:00: get all data objects created in January 2020.

String Date

settledOn=eq:2020-01-01: get all data objects that settled on 1 January 2020.
nextAutoScheduleDate=lt:2021-10-13: get all data objects that are next auto schedule date less than October 13th, 2021.

String Time

paymentProcessingTime=eq:16:00:00: get all data objects that are payment processing time at 4pm.

String Fields

Attributes of this type are generally limited to eq, in, nin, neq, nn, & null operators.

Boolean Fields

Attributes of this type are generally limited to eq, neq, nn, & null operators.

Bool

hasCompletedVerification=eq:1: Find passed verifications.
isReceivingUpdates=neq:0: get all records that are not receiving updates.

String Enumerated Fields

Attributes of this type are generally limited to eq, in, nin, neq, nn, & null operators.

String enum

preferredPhone=eq:Home: get all data objects with a preferred phone contact being home phone