Skip to content

Boards Resource

chdastolfo edited this page Dec 10, 2022 · 2 revisions

Boards Resource (monday.boards)

  • fetch_boards(**kwargs) - Fetch boards associated with an account. Returns boards and their groups, tags, and columns. Accepts keyword arguments:

    • limit - The number of boards returned (int. Default is 25).
    • page - The page number returned, should you implement pagination(int. Starts at 1).
    • ids - A list of the unique board identifier(s) (List[int]).
    • board_kind - The board's kind (BoardKind. public / private / share).
    • state - The state of the board (BoardState. all / active / archived / deleted. Default is active).
    • order_by - The order in which to retrieve your boards (BoardsOrderBy. created_at / used_at).
  • fetch_boards_by_id([board_ids]) - Since Monday does not allow querying boards by name, you can use fetch_boards to get a list of boards, and then fetch_boards_by_id to get more detailed info about the groups and columns on that board. Accepts a comma separated list of board ids.

  • fetch_columns_by_board_id([board_ids]) - Get all columns, as well as their ids, types, and settings. Accepts a comma separated list of board ids.

  • fetch_items_by_board_id([board_ids], **kwargs) - Get all items on a board(s). Accepts a comma separated list of board ids.

    • limit - The number of rows returned (int. no default).
    • page - The page number returned, should you implement pagination(int. no default).
  • create_board(board_name, board_kind, workspace_id) - Create board with the given name and kind by (and optional) workspace id.

Clone this wiki locally