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

    Interface GetBoard

    Details about a board.

    interface GetBoard {
        admins?: {
            groups?: { name?: string; self?: string }[];
            users?: {
                accountId?: string;
                active?: boolean;
                avatarUrls?: AgileModels.AvatarUrls;
                displayName?: string;
                self?: string;
            }[];
        };
        canEdit?: boolean;
        favourite?: boolean;
        id?: number;
        isPrivate?: boolean;
        location?: {
            avatarURI?: string;
            displayName?: string;
            name?: string;
            projectId?: number;
            projectKey?: string;
            projectName?: string;
            projectTypeKey?: string;
            userAccountId?: string;
            userId?: number;
        };
        name?: string;
        self?: string;
        type?: string;
    }
    Index

    Properties

    admins? canEdit? favourite? id? isPrivate? location? name? self? type?

    Properties

    admins?: {
        groups?: { name?: string; self?: string }[];
        users?: {
            accountId?: string;
            active?: boolean;
            avatarUrls?: AgileModels.AvatarUrls;
            displayName?: string;
            self?: string;
        }[];
    }

    The users and groups who own the board.

    canEdit?: boolean

    Whether the board can be edited.

    favourite?: boolean

    Whether the board is selected as a favorite.

    id?: number

    The ID of the board.

    isPrivate?: boolean

    Whether the board is private.

    location?: {
        avatarURI?: string;
        displayName?: string;
        name?: string;
        projectId?: number;
        projectKey?: string;
        projectName?: string;
        projectTypeKey?: string;
        userAccountId?: string;
        userId?: number;
    }

    The container that the board is located in.

    name?: string

    The name of the board.

    self?: string

    The URL of the board.

    type?: string

    The type the board.

    Settings

    Member Visibility

    On This Page

    Properties