> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/user-api/resources/commons/entity/search_conditions.md). # Entity search conditions The filter expression that narrows an entity list by built-in and custom fields. A search condition filters a list of entities by their fields, both the built-in ones and the [custom fields](/docs/navixy-api/user-api/resources/commons/entity/fields.md) an account has added. Operations that accept a `conditions` parameter, such as `checkin/list`, take the structure described here. ## Search conditions object Conditions are an array, and each condition evaluates to either true or false. They nest: `and`, `or`, and `not` take further conditions as their operands, so an arbitrary boolean expression can be built. Conditions in the top-level array are joined with `AND`. ```json [ { "type": "and", "conditions": [ { "type": "or", "conditions": [ { "type": "eq", "field": "18", "value": 1111 }, { "type": "contains", "field": "27", "value": "qqq" } ] }, { "type": "contains", "field": "label", "value": "who" } ] } ] ``` > A maximum of 72 conditions can be used at once, including nested conditions. ## Condition types ### AND condition This condition evaluates all specified sub-conditions and joins them using the `AND` boolean operator. ```json { "type": "and", "conditions": [ { "type": "eq", "field": "18", "value": 1111 }, { "type": "contains", "field": "27", "value": "qqq" } ] } ``` * `conditions` - array. Contains from 2 to 60 sub-conditions to be joined. ### OR condition This condition evaluates all specified sub-conditions and joins them using the `OR` boolean operator. ```json { "type": "or", "conditions": [ { "type": "eq", "field": "18", "value": 1111 }, { "type": "contains", "field": "27", "value": "qqq" } ] } ``` * `conditions` - array. Contains from 2 to 60 sub-conditions to be joined. ### NOT condition This condition evaluates a sub-condition and negates its result. If the sub-condition evaluates to `true`, the `NOT` condition will be evaluated as `false`, and vice versa. ```json { "type": "not", "condition": { "type": "eq", "field": "18", "value": 1111 } } ``` * `condition` - object. A single condition to be negated. ### NUMBER EQUALS condition This condition checks if the specified field is equal to the provided number value. It also works for text fields (e.g., “111” is considered equal to 111). For linked entity fields, it matches the linked entity ID to the number value. ```json { "type": "eq", "field": "18", "value": 1111 } ``` * `field` - string. A standard field or field ID. * `value` - int. Number value to match against the field. Can be decimal, must be between -2^63 and 2^63-1, with no more than 6 fractional digits. ### CONTAINS STRING condition This condition checks if the specified field contains a substring equal to the provided value. It also works for number fields (e.g., 123123 contains “123”). For linked entity fields, it matches the value against the linked entity label or other similar fields (e.g., first name, last name). ```json { "type": "contains", "field": "label", "value": "who" } ``` * `field` - string. A standard field or field ID. * `value` - string. Value to match against the field. Cannot be null or empty, maximum length is 760 characters. ### IN condition This condition checks if the specified field matches any value within the provided array of values. ```json { "type": "in", "field": "18", "value": [1111, 2222, 3333] } ``` * `field` - string. A standard field or field ID. * `value` - array. Contains a list of values to match against the field. Each value must follow the same rules as in`NUMBER EQUALS` or `CONTAINS STRING` conditions, depending on the field type. ### TIMESTAMP IN THE PERIOD condition This condition checks if the specified timestamp field falls within a given period. The period is inclusive, meaning it includes both the `from` and `to` timestamps. ```json { "type": "period", "field": "creation_date", "value": { "from": "2023-01-01T00:00:00Z", "to": "2023-12-31T23:59:59Z" } } ``` * `field` - string. The name or ID of the timestamp field to evaluate. * `value` - object. Contains the `from` and `to` values defining the period. * `from` - [date/time](/docs/navixy-api/general/api-conventions.md#data-types). The beginning of the period. * `to` - [date/time](/docs/navixy-api/general/api-conventions.md#data-types). The end of the period. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://navixy.com/docs/navixy-api/user-api/resources/commons/entity/search_conditions.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.