Boards API

This page describes all the functions concerning the boards on Trello.

How can I access the functions of this category?

[ 1 ] - Open a ServerScript [ 2 ] - Look at the following script. (Example script to understand how to access a category and to a function)

-- // Require TrelloAPI Module
local TrelloApi = require(game.ServerScriptService:WaitForChild("TrelloAPI"))

-- // Access to the Category, SubCategory and Function
TrelloApi.BoardsApi.Utility.[FUNCTION NAME]

---

UTILITY SUBCATEGORY

GetBoardId(Name: req)

Return the ID of the board; Return false if the function fail. (No case sensitive)

TrelloApi.BoardsApi.Utility.GetBoardId("EXAMPLE_BOARD_NAME")

GetBoardInfo(BoardId: req)

Return the board object ; Return false if the function fail.

TrelloApi.BoardsApi.Utility.GetBoardInfo("BOARD_ID")

GetCardsOnBoard(BoardId: req)

Return all the cards in the target board (Lua Table); Return false if the function fail.

TrelloApi.BoardsApi.Utility.GetCardsOnBoard("BOARD_ID")

GetCardOnBoard(BoardId: req, Name: req)

Return information about a specific Card in a specific Board (Lua Table); Return false if the function fail. (No case sensitive)

TrelloApi.BoardsApi.Utility.GetCardOnBoard(BoardId, "CARD_NAME")

GetLabelsOnBoard(BoardId: req)

Return all the labels in the target board (Lua Table); Return false if the function fail.

TrelloApi.BoardsApi.Utility.GetLabelsOnBoard("BOARD_ID")

---

LISTS SUBCATEGORY

GetListsOnBoard(BoardId: req)

Return all the List in the target Board (Lua Table); Return false if the function fail.

TrelloApi.BoardsApi.Lists.GetListsOnBoard("BOARD_ID")

GetListId(BoardId: req, Name: req)

Return The ID of the list in the target Board (String); Return false if the function fail.

TrelloAPI.BoardsAPI.GetListID("BOARD_ID", "EXAMPLE_LIST_NAME")

CreateListOnBoard(BoardId: req, Name: req, Position: opt)

Create a List in a specific Board, Return true if the function is successful false if the function fail.

TrelloApi.BoardsApi.Lists.CreateListOnBoard(BoardId, "EXAMPLE_LIST_NAME", "top || bottom")

---

ACTIONS SUBCATEGORY

CreateBoard (Name: req)

Create a List in a specific Board, Return true if the function is successful false if the function fail.

TrelloApi.BoardsApi.Actions.CreateBoard("EXAMPLE_BOARD_NAME")

ModifyBoard(BoardId: req, OptionalData: opt)

Modify a Board, Return true if the function is successful false if the function fail.

TrelloApi.BoardsApi.Actions.ModifyBoard("BOARD_ID", {
    Name = "EXAMPLE_NAME",
    Description = "EXAMPLE_DESCRIPTION",
    Closed = true || false,
})

Note that you can remove one of that elements or just don't include the 'OptionalData' table.