Learn about how to use filter formulas when searching objects in the Ironclad Public API
Several list endpoints support a filter query parameter that lets you narrow results using formula expressions. The property reference should be enclosed in brackets [ ] and string values should be enclosed in single quotes ' ' or double quotes " ".
Supported Operations
Equality
| Operation | Parameters | Supported Types | Example |
|---|---|---|---|
Equals | 2 | strings, numbers, dates, booleans | Equals([counterpartyName], 'Acme Corp.') |
NotEqual | 2 | strings, numbers, dates, booleans | NotEqual([counterpartyName], 'Acme Corp.') |
String Matching
| Operation | Parameters | Supported Types | Example |
|---|---|---|---|
Contains | 2 | strings | Contains([counterpartyName], 'Acme') |
Emptiness Checks
| Operation | Parameters | Supported Types | Example |
|---|---|---|---|
IsEmpty | 1 | any | IsEmpty([counterpartyName]) |
IsNotEmpty | 1 | any | IsNotEmpty([counterpartyName]) |
Comparison
| Operation | Parameters | Supported Types | Example |
|---|---|---|---|
LessThan | 2 | numbers, dates | LessThan([amount], '1000') |
LessThanOrEqual | 2 | numbers, dates | LessThanOrEqual([amount], '1000') |
GreaterThan | 2 | numbers, dates | GreaterThan([amount], '1000') |
GreaterThanOrEqual | 2 | numbers, dates | GreaterThanOrEqual([amount], '1000') |
Logical Combinators
| Operation | Parameters | Example |
|---|---|---|
And | 2 or more | And(GreaterThan([amount], '1000'), Contains([counterpartyName], 'Acme')) |
Or | 2 or more | Or(Contains([counterpartyName], 'Acme'), Contains([counterpartyName], 'Corp')) |
And and Or accept two or more formula expressions as arguments, allowing you to compose complex filters.
Date Functions
Date functions can be used as values in comparison and equality operations.
| Function | Parameters | Description |
|---|---|---|
Today() | 0 | Resolves to the current date. |
Date(year, month, day) | 3 | A specific calendar date. Year must be a number, month between 1–12, and day must be valid for the given month and year. |
RelativeDate(anchor, offset, unit) | 3 | A date relative to an anchor. The anchor must be Today() or a Date(...) expression. We do not support using a property reference as an anchor. The offset is a numeric value (positive or negative). The unit is a string whose value can be one of 'days', 'weeks', 'months', or 'years'. |
Examples:
Equals([startDate], Date(2025, 6, 15))
GreaterThan([startDate], Today())
LessThan([endDate], RelativeDate(Today(), 30, "days"))
GreaterThanOrEqual([startDate], RelativeDate(Date(2025, 1, 1), -6, "months"))Combining Filters
You can nest logical combinators to build complex queries:
And(
Or(Equals([counterpartyName], 'Acme Corp'), Equals([counterpartyName], 'Acme Corporation')),
GreaterThan([agreementDate], Date(2025, 1, 1)),
IsNotEmpty([amount])
)