Skip to main content
The Deno 2 Release Candidate is here
Learn more
Module

x/jira/src/agile/parameters/getAllBoards.ts>GetAllBoards

A JavaScript/TypeScript wrapper for the JIRA Cloud, Service Desk and Agile REST API
Latest
interface GetAllBoards
import { type GetAllBoards } from "https://deno.land/x/jira@v3.0.2/src/agile/parameters/getAllBoards.ts";

Properties

optional
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.

optional
maxResults: number

The maximum number of boards to return per page. See the 'Pagination' section at the top of this page for more details.

optional
type: string

Filters results to boards of the specified types. Valid values: scrum, kanban, simple.

optional
name: string

Filters results to boards that match or partially match the specified name.

optional
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.

optional
accountIdLocation: string
optional
projectLocation: string
optional
includePrivate: boolean

Appends private boards to the end of the list. The name and type fields are excluded for security reasons.

optional
negateLocationFiltering: boolean

If set to true, negate filters used for querying by location. By default false.

optional
orderBy:
| "name"
| "-name"
| "+name"
| string

Ordering of the results by a given field. If not provided, values will not be sorted. Valid values: name.

optional
expand: string

List of fields to expand for each board. Valid values: admins, permissions.

optional
filterId: number

Filters results to boards that are relevant to a filter. Not supported for next-gen boards.