Function getAllBoards

getAllBoards(
    client: Client,
    parameters?: {
        maxResults?: number;
        name?: string;
        projectKeyOrId?: string;
        startAt?: number;
        type?: string | string[];
    },
    options?: RequestOptions,
): Promise<
    {
        isLast: boolean;
        maxResults: number;
        startAt: number;
        total?: number;
        values: {
            id?: number;
            name?: string;
            self?: string;
            type?: string;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
Returns all boards. This only includes boards that the user has permission to view.
Parameters
- client: Client
- Optionalparameters: {
      maxResults?: number;
      name?: string;
      projectKeyOrId?: string;
      startAt?: number;
      type?: string | string[];
  }
  - OptionalmaxResults?: number
    
    The maximum number of boards to return per page. Default: 50.
  - Optionalname?: string
    
    Filters results to boards that match or partially match the specified name.
  - OptionalprojectKeyOrId?: string
    
    Filters results to boards that are relevant to a project.
  - OptionalstartAt?: number
    
    The starting index of the returned boards. Base index: 0.
  - Optionaltype?: string | string[]
    
    Filters results to boards of the specified type. Valid values: scrum, kanban.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        isLast: boolean;
        maxResults: number;
        startAt: number;
        total?: number;
        values: {
            id?: number;
            name?: string;
            self?: string;
            type?: string;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
- Defined in src/server/api/board.ts:40

Function getAllBoards

Parameters

`Optional`maxResults?: number

`Optional`name?: string

`Optional`projectKeyOrId?: string

`Optional`startAt?: number

`Optional`type?: string | string[]

Settings

Function getAllBoards

Parameters

OptionalmaxResults?: number

Optionalname?: string

OptionalprojectKeyOrId?: string

OptionalstartAt?: number

Optionaltype?: string | string[]

Returns Promise< { isLast: boolean; maxResults: number; startAt: number; total?: number; values: { id?: number; name?: string; self?: string; type?: string; [key: string]: unknown; }[]; [key: string]: unknown; },>

Settings

`Optional`maxResults?: number

`Optional`name?: string

`Optional`projectKeyOrId?: string

`Optional`startAt?: number

`Optional`type?: string | string[]

Returns Promise<
{
isLast: boolean;
maxResults: number;
startAt: number;
total?: number;
values: {
id?: number;
name?: string;
self?: string;
type?: string;
[key: string]: unknown;
}[];
[key: string]: unknown;
},
>