Function: getBoardByFilterId()

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

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

Returns any boards which use the provided filter id. This method can be executed by users without a valid software license in order to find which boards are using a particular filter.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ filterId: number; maxResults?: number; startAt?: number; }	-
parameters.filterId	number	Filters results to boards that are relevant to a filter. Not supported for next-gen boards.
parameters.maxResults?	number	The maximum number of boards to return per page. Default: 50. See the 'Pagination' section at the top of this page for more details.
parameters.startAt?	number	The starting index of the returned boards. 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[]; }>