Skip to main content

Boards

Complete reference for board-related methods and models.

Methods​

get_boards​

get_boards() -> BoardsResponse

Get all boards in current space.

Returns: BoardsResponse with list of boards

get_board​

get_board(board_id: str) -> BoardResponse

Get a single board by ID.

Parameters:

  • board_id - Board ID

Returns: BoardResponse with board data

create_board_type​

create_board_type(request: CreateBoardTypeRequest) -> CreateBoardTypeResponse

Create a new board type (e.g., Bug, Feature).

Parameters:

  • request - Type configuration (board_id, label, icon, color)

Returns: CreateBoardTypeResponse with created type

edit_board_type​

edit_board_type(request: EditBoardTypeRequest) -> EditBoardTypeResponse

Edit an existing board type.

Parameters:

  • request - Edit request with board_type_id and fields to update

Returns: EditBoardTypeResponse with updated type

create_board_group​

create_board_group(request: CreateBoardGroupRequest) -> CreateBoardGroupResponse

Create a new board group (column).

Parameters:

  • request - Group configuration (name, board_id)

Returns: CreateBoardGroupResponse with all board groups

edit_board_group​

edit_board_group(request: EditBoardGroupRequest) -> EditBoardGroupResponse

Edit an existing board group.

Parameters:

  • request - Edit request with board_group_id and fields to update

Returns: EditBoardGroupResponse with all board groups

Models​

Board​

Main board model representing a board in the system.

class Board:
    id: str                              # Board ID
    name: str                            # Board name
    project: Optional[str]               # Project ID
    groups: Optional[List[BoardGroup]]   # Board groups (columns)
    types_list: Optional[List[BoardType]]  # Task types
    custom_fields: Optional[List[BoardCustomField]]  # Custom fields
    task_order_by_groups: Optional[Dict[str, List[str]]]  # Task ordering
    creator: Optional[str]               # Creator ID
    archiver: Optional[str]              # Archiver ID (if archived)
    deleter: Optional[str]               # Deleter ID (if deleted)
    archived_at: Optional[datetime]      # Archive timestamp
    created_at: Optional[datetime]       # Creation timestamp
    updated_at: Optional[datetime]       # Last update timestamp
    deleted_at: Optional[datetime]       # Deletion timestamp

BoardGroup​

class BoardGroup:
    id: str                    # Group ID
    name: str                  # Group name
    description: Optional[str] # Description
    limit: Optional[int]       # Task limit for group
    hidden: Optional[bool]     # Hidden status

BoardType​

class BoardType:
    id: str                    # Type ID
    label: str                 # Type label
    icon: Icon                 # Type icon
    color: Union[str, Color]   # Type color
    description: Optional[str] # Description
    hidden: Optional[bool]     # Hidden status

Response Models​

BoardResponse​

class BoardResponse:
    type: str                   # Response type ("GetBoard")
    payload: Dict[str, Board]   # Response payload
    
    @property
    def board(self) -> Board:  # Convenience property
        ...

BoardsResponse​

class BoardsResponse:
    type: str                    # Response type ("GetBoards")
    payload: BoardsPayload       # Response payload
    
    @property
    def boards(self) -> List[Board]:  # Convenience property
        ...

BoardsPayload​

class BoardsPayload:
    boards: List[Board]         # List of boards

Request Models​

CreateBoardTypeRequest​

class CreateBoardTypeRequest:
    board_id: str                       # Required - Board ID
    label: str                          # Required - Type label
    icon: Icon                         # Required - Type icon
    color: Color                       # Required - Type color

EditBoardTypeRequest​

class EditBoardTypeRequest:
    board_type_id: str                  # Required - Type ID
    board_id: str                       # Required - Board ID
    label: Optional[str]                # New label
    icon: Optional[Icon]               # New icon
    color: Optional[Color]             # New color
    description: Optional[str]          # New description
    hidden: Optional[bool]              # Hidden status

CreateBoardGroupRequest​

class CreateBoardGroupRequest:
    name: str                           # Required - Group name
    board_id: str                       # Required - Board ID
    description: Optional[str]          # Description

EditBoardGroupRequest​

class EditBoardGroupRequest:
    board_group_id: str                 # Required - Group ID
    board_id: str                       # Required - Board ID
    name: Optional[str]                 # New name
    description: Optional[str]          # New description
    limit: Optional[int]                # Task limit
    hidden: Optional[bool]              # Hidden status

CreateBoardTypeResponse​

class CreateBoardTypeResponse:
    type: str                           # Response type
    payload: CreateBoardTypePayload     # Response payload
    
    @property
    def board_type(self) -> BoardType: # Convenience property
        ...

CreateBoardTypePayload​

class CreateBoardTypePayload:
    boardType: BoardType                # Created board type

EditBoardTypeResponse​

class EditBoardTypeResponse:
    type: str                           # Response type
    payload: EditBoardTypePayload       # Response payload
    
    @property
    def board_type(self) -> BoardType: # Convenience property
        ...

EditBoardTypePayload​

class EditBoardTypePayload:
    boardType: BoardType                # Edited board type

CreateBoardGroupResponse​

class CreateBoardGroupResponse:
    type: str                           # Response type
    payload: CreateBoardGroupPayload    # Response payload
    
    @property
    def board_groups(self) -> List[BoardGroup]:  # Convenience property
        ...

CreateBoardGroupPayload​

class CreateBoardGroupPayload:
    boardGroups: List[BoardGroup]       # All board groups

EditBoardGroupResponse​

class EditBoardGroupResponse:
    type: str                           # Response type
    payload: EditBoardGroupPayload      # Response payload
    
    @property
    def board_groups(self) -> List[BoardGroup]:  # Convenience property
        ...

EditBoardGroupPayload​

class EditBoardGroupPayload:
    boardGroups: List[BoardGroup]       # All board groups

See Also​