Guidelines for Using Filters

Basic Syntax

Supported Operators

Comparison Operators

Operator	Description	Example Value
`eq`	Equal to	`"Beijing"` or `["<targetid>"]`
`ne`	Not equal to	`"London"` or `["<targetid>"]`
`gt`	Greater than	`20` or `"2025-02-06 00:00:00"`
`ge`	Greater than or equal to	`10`
`lt`	Less than	`20`
`le`	Less than or equal to	`100`
`in`	Is one of	`["value1", "value2"]`
`notin`	Is not any of	`["value1", "value2"]`
`contains`	Contains	`"Ch"` or `["Sales Department", "Marketing Department"]`
`notcontains`	Does not contain	`"Ch"` or `["Sales Department", "Marketing Department"]`
`concurrent`	Contains	`["<id1>", "<id2>"]`
`belongsto`	Belongs to	`["<departmentid>"]`
`notbelongsto`	Does not belong to	`["<departmentid>"]`
`startswith`	Starts with	`"张"`
`notstartswith`	Does not start with	`"李"`
`endswith`	Ends with	`"Company"`
`notendswith`	Does not end with	`"Limited Company"`
`between`	In range	`["2025-01-01", "2025-01-31"]`
`notbetween`	Not in range	`["10", "20"]`

Null Operator

Operator	Description	Notes
`isempty`	Is empty	Does not require a value field
`isnotempty`	Is not empty	Does not require a value field

Special AccountIDs

ID	Description
user-self	Current user
user-sub	Subordinates
user-workflow	Workflow
user-api	API

Usage Examples

Example 1: Filter Conditions

Query all employees with the surname "Zhang" who joined in January:

{
"type": "group",
"logic": "AND",
"children": [
{
"type": "condition",
"field": "name",
"operator": "startswith",
"value": "Zhang"
},
{
"type": "condition",
"field": "onboard_date",
"operator": "between",
"value": ["2025-01-01", "2025-01-31"]
}
]
}

Example 2: Condition Groups

Query all employees with the surname "Zhang" who joined in January in the Marketing and Sales Departments in North China:

{
"type": "group",
"logic": "AND",
"children": [
{
"type": "group", 
"logic": "AND", 
"children": [ 
{ 
"type": "condition", 
"field": "name", 
"operator": "startswith", 
"value": "张" 
}, 
{ 
"type": "condition", 
"field": "onboard_date", 
"operator": "between", 
"value": ["2025-01-01", "2025-01-31"] 
} 
] 
}, 
{ 
"type": "group", 
"logic": "OR", 
"children": [ 
{ 
"type": "condition", 
"field": "department_name", 
"operator": "contains", 
"value": ["Sales Department", "Marketing Department"] 
}, 
{ 
"type": "condition", 
"field": "department_id", 
"operator": "belongsto", 
"value": ["North China ID"] 
} 
] 
} ]
}

Notes

Nesting Limitations: Supports a maximum of two levels of nesting (group -> group -> condition).

Children Type Consistency: A group's children can only be either all group or all condition; a mixture is not allowed.

Logic Required: When type is group, the logic field must be specified as AND or OR.

Null Operator: The value field is not required when using isempty and isnotempty.

Array Value: Certain operators require array values (such as between, in, contains, concurrent, belongsto, etc.).

Optional Fields: All optional fields (single-select and multiple-select) must use the corresponding option key value in an array as the value and use array-valued operators.

Related Records: To filter the associated records, you need to first query the corresponding record_id and then filter by the array value rule.

Guidelines for Using Filters

Basic Syntax#

Supported Operators#

Comparison Operators#

Null Operator#

Special AccountIDs#

Usage Examples#

Example 1: Filter Conditions#

Example 2: Condition Groups#

Notes#