Record Filters
record.filters
record.filters data queries return the available search filters for a given record type. This is useful for dynamic filter discovery, powering LLM search agents, and building autocomplete interfaces.
Inputs
| Req'd | Key | Notes |
|---|---|---|
| x | of: |
The record type alias (e.g. ticket) |
exclude_links: |
yes to omit virtual link filters (default no) |
Response Formats
- dictionaries (default) returns a table-based format suitable for sheets and API results.
Examples
Query:
type:record.filters
of:ticket
exclude_links:yes
format:dictionariesResponse:
{
"data": {
"id": {
"type": "number",
"options": { "param_key": "t_id" },
"examples": [
{ "type": "chooser", "context": "cerberusweb.contexts.ticket", "q": "" }
],
"is_sortable": true
},
"mask": {
"type": "text",
"options": { "param_key": "t_mask", "match": 1 },
"is_sortable": true
},
"subject": {
"type": "text",
"options": { "param_key": "t_subject", "match": 1 },
"is_sortable": true
},
"status": {
"type": "virtual",
"options": { "param_key": "t_status_id" },
"examples": ["open", "waiting", "closed", "deleted", "[o,w]", "![d]"],
"is_sortable": true
},
"owner": {
"type": "virtual",
"options": { "param_key": "*_owner_search" },
"examples": [
{ "type": "search", "context": "cerberusweb.contexts.worker", "q": "" }
],
"is_sortable": false
},
"group.id": {
"type": "chooser",
"options": { "param_key": "t_team_id" },
"examples": [
{ "type": "chooser", "context": "cerberusweb.contexts.group", "q": "" }
],
"is_sortable": true
},
"bucket.id": {
"type": "chooser",
"options": { "param_key": "t_bucket_id" },
"examples": [
{ "type": "chooser", "context": "cerberusweb.contexts.bucket", "q": "" }
],
"is_sortable": true
}
},
"_": {
"type": "record.filters",
"format": "dictionaries"
}
}Each key in data is a filter name usable in search queries. Each entry includes:
| Field | Description |
|---|---|
type |
The filter type (e.g. fulltext, date, number, text, virtual, worker) |
options |
Internal options including param_key (the underlying query parameter) |
examples |
Optional sample values; strings for literal input, or objects with type: "chooser" or type: "search" for record pickers |
is_sortable |
Whether this filter's field can be used for sorting results |