List Entries
list_entriesQuery Inistate module entries with filters, sorting, pagination, field selection, and free-text search to return only the records you need.
Instructions
Query entries with filters, sorting, pagination. Filter keys are field display names; values are equality (simple) or operator objects (contains/startsWith/endsWith/min/max/above/below/between/after/before/empty/exists/yes/no/is/not/excludes). Use {or:[…]} for OR; multiple keys are AND-ed. Use 'me' for User-field self-match. See FilterOperators in inistate://schema/runtime for the full set.
Access: non-admin users cannot query the unfiltered default 'Everything' view on modules that have listings — pass listing with one of their accessible listings (an access-denied response names them).
Token control: use fields to restrict the returned data to just the columns you need. For modules with many fields this can shrink the response by an order of magnitude. Every item carries entryId, documentId and state whatever fields holds; the other system fields (date, createdBy, createdDate, updatedBy, updatedDate, assignees, due) come with the full row, but when fields is given only if it names them.
Check each item's state before totalling, counting or ranking entries: a Cancelled or Draft entry usually must not count. get_module_schema's stateDetails says what each state means.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| state | No | ||
| fields | No | Field display names (or raw field names) to include in each entry's `data`. Strongly preferred over returning everything when the module has many or large fields — prunes both DB I/O and response tokens. Omit only when you actually need the full row. entryId, documentId and state are always returned; name any other system field (date, createdBy, createdDate, updatedBy, updatedDate, assignees, due) here to get it. | |
| module | Yes | Module name from list_modules | |
| search | No | Free-text search across document ID, state, and text-like fields; supports * and ? wildcards | |
| sortBy | No | ||
| filters | No | ||
| listing | No | Listing (saved view) name to query, case-insensitive; 'archive' targets archived entries. Defaults to the unfiltered 'Everything' view, which is admin-only on modules with listings — non-admins must name an accessible listing (an access-denied response lists them). | |
| pageSize | No | Default 50, max 500 | |
| currentPage | No | ||
| workspaceId | No | Workspace ID. Omit if set via env or set_workspace; required in stateless/remote mode. | |
| sortDirection | No | asc |