Function: getAllBoards()

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

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

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

Deprecation notice: The required OAuth 2.0 scopes will be updated on February 15, 2024.

• read:board-scope:jira-software, read:project:jira

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ accountIdLocation?: string; expand?: | string & object | "permissions" | "admins" | (string & object | "permissions" | "admins")[]; filterId?: number; includePrivate?: boolean; maxResults?: number; name?: string; negateLocationFiltering?: boolean; orderBy?: "name" | string & object | "-name" | "+name"; projectKeyOrId?: string; projectLocation?: string; projectTypeLocation?: string[]; startAt?: number; type?: string & object | "simple" | "scrum" | "kanban"; }	-
parameters.accountIdLocation?	string	-
parameters.expand?	| string & object | "permissions" | "admins" | (string & object | "permissions" | "admins")[]	List of fields to expand for each board. Valid values: admins, permissions.
parameters.filterId?	number	Filters results to boards that are relevant to a filter. Not supported for next-gen boards.
parameters.includePrivate?	boolean	Appends private boards to the end of the list. The name and type fields are excluded for security reasons.
parameters.maxResults?	number	The maximum number of boards to return per page. See the 'Pagination' section at the top of this page for more details.
parameters.name?	string	Filters results to boards that match or partially match the specified name.
parameters.negateLocationFiltering?	boolean	If set to true, negate filters used for querying by location. By default false.
parameters.orderBy?	"name" | string & object | "-name" | "+name"	Ordering of the results by a given field. If not provided, values will not be sorted. Valid values: name.
parameters.projectKeyOrId?	string	Filters results to boards that are relevant to a project. Relevance means that the jql filter defined in board contains a reference to a project.
parameters.projectLocation?	string	-
parameters.projectTypeLocation?	string[]	Filters results to boards that are relevant to a project types. Support Jira Software, Jira Service Management. Valid values: software, service_desk. By default software.
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.
parameters.type?	string & object | "simple" | "scrum" | "kanban"	Filters results to boards of the specified types. Valid values: scrum, kanban, simple.
options?	RequestOptions	-

Returns

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