Skip to content

Function: getQuickFilter() ​

ts
function getQuickFilter(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  boardId?: number;
  description?: string;
  id?: number;
  jql?: string;
  name?: string;
  position?: number;
}>;

Defined in: src/agile/api/board.ts:634

Returns the quick filter for a given quick filter ID. The quick filter will only be returned if the user can view the board that the quick filter belongs to.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ boardId: number; quickFilterId: number; }-
parameters.boardIdnumber-
parameters.quickFilterId?numberThe ID of the requested quick filter.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; boardId?: number; description?: string; id?: number; jql?: string; name?: string; position?: number; }>