Filters for list functions

The API supports filtering functionality on list functions using various operators on different keys to refine the query results.

Filters

The API parameter filters accepts an array of filter objects, allowing 0 to n filters to be applied.

Exemple based on the contactList function:

{
    "firstName": {
        "LIKE": "Foo%"
    },
    "idContact": {
        ">=": "XX001",
        "<": "XX999"
    },
    "bodyForm": {
        "IN": ["IND", "ORG"]
    },
    "IsOwner": {
        "<>": "1"
    }
}

Filter structure

Each filter object consists of:

Key: The attribute on which the filter is applied.
Operator: Specifies the type of comparison or operation to be performed.
Value(s): The value(s) to be compared against based on the operator.

Value	Type	Length	Description
filters	array	0-n	List of filters to be applied
filters.{key}	array	1-2	Array containing the filter for the key
{key}	string	0-n	Key to apply the filter to
filters.{key}.{operator}	string\|array	0-n	Value(s) to be compared against
{operator}	string	1-8	Operator used for filtering

Filter examples :

Comparison	Example
Single value	"{key}": { "{operator}": "{value}" }
Multiple values	"{key}": { "{operator}": [ "{value1}", "{value2}" ] }
Multiple operators	"{key}": { "{operator1}": "{value1}", "{operator2}": "{value2}" }

Operators

Available Operators:

Operator	Expected value type	Combinable	Description
=	string	No	Equal to
<>	string	No	Not equal to
IN	array	No	Matches any value in a given set
NOT IN	array	No	Does not match any value in a given set
LIKE	string	No	Matches a pattern
NOT LIKE	string	No	Does not match a pattern
>	string	Yes	Greater than
>=	string	Yes	Greater than or equal to
<	string	Yes	Less than
<=	string	Yes	Less than or equal to

Two operators can be combined by using > with < or <=, or < with > or >= for range-based comparisons.

Keys

Keys are specific to each function. For more information, see the corresponding pages.