Skip to main content
POST
Preview results
Returns the cards, pages or boards matching a set of filter conditions, without creating a saved filter. Set type to card, page or board to choose what the filter returns. This is the structured counterpart to search: use this endpoint to find items by their properties — assignee, status, tags, dates, space — and search to match on text. It is also the unsaved equivalent of Get saved filter results, so it is useful for trying conditions out before creating a saved filter, or for one-off queries you don’t want to keep.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

team_id
string
required

Team ID is an alphanumerical string that identifies a Team. This is externally referred to as a "Workspace".

Query Parameters

cursor
string

cursor for pagination

count
integer

max number of items to return. defaults to 25

Body

application/json

Preview request. Must include a type and the corresponding set of filters

board_filters
object | null
card_filters
object | null
page_filters
object | null
type
enum<string>
Available options:
board,
card,
page
Example:

"card"

Response

Preview results

cursor
string
required
Example:

"dmsjqh9d8w1hdjosjaasda"

count
integer
required
Example:

14

boards
object[]
cards
object[]
pages
object[]