Interface SearchParams

Query parameters for GET /rest/api/latest/search.

interface SearchParams {
    expand?: string;
    fields?: string;
    jql?: string;
    maxResults?: number;
    startAt?: number;
    validateQuery?: boolean;
}

Properties

expand? fields? jql? maxResults? startAt? validateQuery?

Properties

Optionalexpand

expand?: string

Fields to expand (e.g. 'changelog,renderedFields,names')

Optionalfields

fields?: string

Comma-separated list of fields to include. Use '*all' for all fields, '*navigable' for navigable fields (default).

Optionaljql

jql?: string

JQL query string (e.g. 'project = PROJ AND status = Open ORDER BY created DESC')

OptionalmaxResults

maxResults?: number

Maximum number of results to return. Jira Data Center defaults to 50; the server cap is configurable.

OptionalstartAt

startAt?: number

Index of the first result (0-based)

OptionalvalidateQuery

validateQuery?: boolean

Whether Jira should validate the JQL query.

Settings

Member Visibility

On This Page

Properties