worklist.records

worklist.records data queries retrieve record dictionaries with a search query.

type:worklist.records
of:ticket
expand:[group_,custom_]
query:(
  status:open
  limit:10
  sort:-updated
)
format:dictionaries

of:
query:
query.required:
expand:
page:
timeout:
format:
Examples
- Return a stacked bar chart of tickets by owner by status

of:

The of: key specifies the type of records to retrieve.

of:ticket

query:

The query: key specifies the query for filtering the results.

A query's limit: is clamped to 1-250 results. Larger values are silently reduced to 250, so a limit:1000 returns a partial result set without any warning. Use page: to retrieve the results beyond the first page.

query.required:

The query.required: key specifies the required query for filtering the results. This is used to set the scope and should never contain placeholders with user input.

expand:

The expand: key specifies which key paths should be expanded in the results.

expand:[custom_,group_,owner_]

page:

The page: key specifies the page to return. Pages numbering is zero-based. This is used by functionality like sheets.

Since a query returns at most 250 results, page: is how you work through a larger set. With limit:250, page:0 returns results 1-250, page:1 returns 251-500, and so on.

timeout:

The time limit of the query in milliseconds (0-60000). Default: 20000.

format:

The worklist results can be returned in these formats:

dictionaries (default) returns a table-based format suitable for sheets and API results.

Examples

Return a stacked bar chart of tickets by owner by status

type:worklist.records
of:ticket
query:(status:open owner.id:me)
expand:[group_,owner_]
format:dictionaries

Cerb

Worklist Records