Jira.js - Jira Cloud API library
    Preparing search index...

    Interface GetAllBoards

    interface GetAllBoards {
        accountIdLocation?: string;
        expand?: string;
        filterId?: number;
        includePrivate?: boolean;
        maxResults?: number;
        name?: string;
        negateLocationFiltering?: boolean;
        orderBy?: string;
        projectKeyOrId?: string;
        projectLocation?: string;
        projectTypeLocation?: string[];
        startAt?: number;
        type?: string;
    }
    Index

    Properties

    accountIdLocation? expand? filterId? includePrivate? maxResults? name? negateLocationFiltering? orderBy? projectKeyOrId? projectLocation? projectTypeLocation? startAt? type?

    Properties

    accountIdLocation?: string
    expand?: string

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

    filterId?: number

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

    includePrivate?: boolean

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

    maxResults?: number

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

    name?: string

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

    negateLocationFiltering?: boolean

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

    orderBy?: string

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

    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.

    projectLocation?: string
    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.

    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.

    type?: string

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

    Settings

    Member Visibility

    On This Page

    Properties