Search records
search_entityRead-only
Searches records of one entity type with a structured query expression (SQE), for instance 'isActive eq true and startDate ge 2024-01-01'. Call get_entity_definition first for this entityType: SQE uses searchField for text (ct/sw/ew) and field for everything else. Returns up to 10 results in a { data, pagination } envelope. Read get_documentation('search_expressions') before your first query: it carries the operators, the value formats and how to page.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | The SQE query string. Format: 'field operator value'. Use searchField for text operators (ct/sw/ew). Use field for id and non-text filters. Examples: 'searchName ct John', 'id eq 3f2504e0-4f89-11d3-9a0c-0305e82c3301', 'isActive eq true', 'startDate gt 2024-01-01 and endDate lt 2024-12-31'. Omit or leave empty to return all records (unfiltered). | |
| afterId | No | Optional cursor for pagination. Pass the pagination.nextCursor value from the previous response to get the next page. Keep calling until pagination.hasMore is false. | |
| entityType | Yes | Which entity type to search. |