Interface BoardsParams

Query parameters for listing boards.

interface BoardsParams {
    maxResults?: number;
    name?: string;
    projectKeyOrId?: string;
    startAt?: number;
    type?: "scrum" | "kanban";
}

Properties

maxResults? name? projectKeyOrId? startAt? type?

Properties

OptionalmaxResults

maxResults?: number

Maximum number of results

Optionalname

name?: string

Filter boards by name (contains match)

OptionalprojectKeyOrId

projectKeyOrId?: string

Filter boards by project key or ID

OptionalstartAt

startAt?: number

Index of the first result (0-based)

Optionaltype

type?: "scrum" | "kanban"

Filter boards by type: 'scrum' or 'kanban'

Settings

Member Visibility

On This Page

Properties