Interface Search

Hierarchy

  • Search

Properties

detail? entity_types? include? next? page_size? query

Properties

Optional detail

detail?: "full" | "slim"

The amount of detail included in each result item. "full" will include all descriptions and comments and more fields on related items such as pull requests, branches and tasks. "slim" omits larger fulltext fields such as descriptions and comments and only references related items by id. The default is "full".

Optional entity_types

entity_types?: ("milestone" | "story" | "epic" | "iteration")[]

A collection of entity_types to search. Defaults to story and epic. Supports: epic, iteration, milestone, story.

Optional include

include?: "cursors"

Optional next

next?: string

The next page token.

Optional page_size

page_size?: number

The number of search results to include in a page. Minimum of 1 and maximum of 25.

Format

int64

query

query: string

See our help center article on search operators

Min Length

1

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc