Function: getAllBoards()

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

Defined in: src/server/api/board.ts:40

Returns all boards. This only includes boards that the user has permission to view.

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ maxResults?: number; name?: string; projectKeyOrId?: string; startAt?: number; type?: string | string[]; }	-
parameters.maxResults?	number	The maximum number of boards to return per page. Default: 50.
parameters.name?	string	Filters results to boards that match or partially match the specified name.
parameters.projectKeyOrId?	string	Filters results to boards that are relevant to a project.
parameters.startAt?	number	The starting index of the returned boards. Base index: 0.
parameters.type?	string | string[]	Filters results to boards of the specified type. Valid values: scrum, kanban.
options?	RequestOptions	-

Returns

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