Skip to content

Function: getAllQuickFilters() ​

ts
function getAllQuickFilters(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  startAt: number;
  total: number;
  values: object[];
}>;

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

Returns all quick filters from a board, for a given board ID.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ boardId: number; maxResults?: number; startAt?: number; }-
parameters.boardIdnumberThe ID of the board that contains the requested quick filters.
parameters.maxResults?numberThe maximum number of sprints to return per page. See the 'Pagination' section at the top of this page for more details.
parameters.startAt?numberThe starting index of the returned quick filters. Base index: 0. See the 'Pagination' section at the top of this page for more details.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; startAt: number; total: number; values: object[]; }>