Operator

Operator declares the comparison applied by a Condition. There are 28 operators total. Every operator that starts with I is the case-insensitive variant — both sides are normalized with .ToLower() before comparison.

Required values at a glance

Each operator expects a specific number of entries in Condition.Values. Sending the wrong count throws a validation error (RequiredOneValue, RequiredTwoValue, RequiredValues, or NotRequiredValues).

Value count	Operators
0	`IsNull`, `IsNotNull`
1	All equality, contains, starts-with, ends-with, and ordered comparisons (24 operators total).
2 (exactly)	`Between`, `NotBetween`
1+	`In`, `IIn`, `NotIn`, `INotIn`

Equality

Operator	Description	Required Values
`Equal`	Equality (case-sensitive for text).	1
`IEqual`	Equality (case-insensitive).	1
`NotEqual`	Inequality (case-sensitive).	1
`INotEqual`	Inequality (case-insensitive).	1

Contains / StartsWith / EndsWith

Operator	Description	Required Values
`Contains`	Text contains (case-sensitive).	1
`IContains`	Text contains (case-insensitive).	1
`NotContains`	Text does not contain (case-sensitive).	1
`INotContains`	Text does not contain (case-insensitive).	1
`StartsWith`	Starts with (case-sensitive).	1
`IStartsWith`	Starts with (case-insensitive).	1
`NotStartsWith`	Does not start with (case-sensitive).	1
`INotStartsWith`	Does not start with (case-insensitive).	1
`EndsWith`	Ends with (case-sensitive).	1
`IEndsWith`	Ends with (case-insensitive).	1
`NotEndsWith`	Does not end with (case-sensitive).	1
`INotEndsWith`	Does not end with (case-insensitive).	1

Note

Case-insensitive I* operators emit .ToLower() on both sides of the comparison. On SQL Server this is typically free (default collations are case-insensitive). On case-sensitive collations (e.g. PostgreSQL with C locale) this still works but may sidestep an index.

In / NotIn (set membership)

Operator	Description	Required Values
`In`	Value is in the set (case-sensitive for text).	1+
`IIn`	Value is in the set (case-insensitive).	1+
`NotIn`	Value is not in the set (case-sensitive).	1+
`INotIn`	Value is not in the set (case-insensitive).	1+

Ordered comparisons & ranges

Operator	Description	Required Values
`GreaterThan`	Greater than.	1
`GreaterThanOrEqual`	Greater than or equal.	1
`LessThan`	Less than.	1
`LessThanOrEqual`	Less than or equal.	1
`Between`	Inclusive range — first value is the lower bound, second is the upper bound.	2 (exactly)
`NotBetween`	Outside the inclusive range defined by the two values.	2 (exactly)

Null checks

Operator	Description	Required Values
`IsNull`	Property is NULL.	0
`IsNotNull`	Property is NOT NULL.	0

Warning

Sending any value with IsNull / IsNotNull throws NotRequiredValues. Send an empty array: "values": [].

JSON examples

Range (Between):

{
  "sort": 1,
  "field": "Price",
  "dataType": "Number",
  "operator": "Between",
  "values": [100, 500]
}

Set membership (IIn):

{
  "sort": 1,
  "field": "Country",
  "dataType": "Text",
  "operator": "IIn",
  "values": ["USA", "Canada", "UK"]
}

Null check (IsNull):

{
  "sort": 1,
  "field": "DeletedAt",
  "dataType": "DateTime",
  "operator": "IsNull",
  "values": []
}

DataType → which operators each logical type accepts.
Condition validation → the exact error codes thrown on count mismatches.
Error codes → full reference.

← PreviousDataType Next →Connector