Docs »

Records »

Types »

Saved Search

Name (singular): Saved Search
Name (plural): Saved Searches
Alias (uri): saved_search
Identifier (ID):

Records API

These fields are available in the Records API and packages:

Req’d Field Type Notes
x context context The record type of this search query; e.g. ticket
  links links An array of record type:id tuples to link to. Prefix with - to unlink.
x name text The name of this saved search
x owner__context context The record type of this saved search’s owner: app, role, group, or worker
  owner_id number The ID of this saved search’s owner
x query text The search query; e.g. status:o
  tag text A human-friendly nickname for this search (e.g. open_tickets)
  updated_at timestamp The date/time when this record was last modified

Dictionary Placeholders

These placeholders are available in dictionaries for automations, snippets, and API responses:

Field Type Description
_context text Record type extension ID
_label text Label
_type text Record type alias
context text Type
id number Id
name text Name
owner_ record Owner
query text Query
record_url text Record Url
tag text Tag
updated_at date Updated

These optional placeholders are also available with key expansion in dictionaries and the API:

Field Type Description
comment_count number Comment count on the record
comments comments Comments
custom_<id> mixed Custom Fields
links links Links

Search Query Fields

These filters are available in saved search search queries:

Field Type Description
context: text Record Type
fieldset: record Fieldset
id: number Id
name: text Name
query: text Query
tag: text Tag
updated: date Updated

Worklist Columns

These columns are available on saved search worklists:

Column Description
c_context Record Type
c_id Id
c_name Name
c_query Query
c_tag Tag
c_updated_at Updated
cf_<id> Custom Field