Filter

A quick overview of how to correctly set up the filter for the API endpoints.

API Filter Criteria Guide

You can send filter conditions by including special characters in the filter value to specify how the filter should be applied.

Filter Criteria

1. **Contains (`value`)**

Use this filter to search for results that contain a specific substring.
Syntax: Wrap the search value with *.

Example:
```
{
  "name": "*John*"
}
```
- Finds names that contain "John" (e.g., "Johnny", "John Smith").

2. Not Contains (`-value`)

Use this filter to search for results that do not contain a specific substring.
Syntax: Prepend the value with -.

Example:
```
{
  "name": "-John"
}
```
- Excludes names that contain "John" (e.g., excludes "Johnny", "John Smith").

3. **Starts With (`*value`)**

Use this filter to search for results that start with a specific substring.
Syntax: Prepend the value with *.

Example:
```
{
  "name": "*John"
}
```
- Finds names that start with "John" (e.g., "Johnny", "Johnathan").

4. **Ends With (`value*`)**

Use this filter to search for results that end with a specific substring.
Syntax: Append * at the end of the value.

Example:
```
{
  "name": "John*"
}
```
- Finds names that end with "John" (e.g., "Smith John", "John").

5. Less Than (`<value`)

Use this filter to search for results where the value is less than the specified value.
Syntax: Prepend the value with <.

Example:
```
{
  "name": "<John"
}
```
- Finds names that are alphabetically before "John".

6. Less Than or Equal (`<=value`)

Use this filter to search for results where the value is less than or equal to the specified value.
Syntax: Prepend the value with <=.

Example:
```
{
  "name": "<=John"
}
```
- Finds names that are alphabetically before or equal to "John".

7. Greater Than (`>value`)

Use this filter to search for results where the value is greater than the specified value.
Syntax: Prepend the value with >.

Example:
```
{
  "name": ">John"
}
```
- Finds names that are alphabetically after "John".

8. Greater Than or Equal (`>=value`)

Use this filter to search for results where the value is greater than or equal to the specified value.
Syntax: Prepend the value with >=.

Example:
```
{
  "name": ">=John"
}
```
- Finds names that are alphabetically after or equal to "John".

9. Not Equal (`!value`)

Use this filter to search for results that are not equal to the specified value.
Syntax: Prepend the value with !.

Example:
```
{
  "name": "!John"
}
```
- Excludes names that are exactly "John".

10. Equal (`value` or `=value`)

Use this filter to search for results that are equal to the specified value.
Syntax: Either use the plain value or prepend it with = for clarity.

Example:
```
{
  "name": "John"
}
```
- Finds names that are exactly "John".