# Boards API

**How can I access the functions of this category?**

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

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

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

***

## UTILITY SUBCATEGORY

### GetBoardI&#x64;**(`Name: req`)** <a href="#getboardid" id="getboardid"></a>

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

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

### GetBoardInf&#x6F;**(`BoardId: req`)** <a href="#getboardid" id="getboardid"></a>

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

```lua
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.

```lua
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)*

```lua
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.

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

***

## LISTS SUBCATEGORY

### GetListsOnBoar&#x64;**(**`BoardId: req`**)** <a href="#getboardid" id="getboardid"></a>

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

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

### GetListI&#x64;**(**`BoardId: req`, `Name: req`**)** <a href="#getboardid" id="getboardid"></a>

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

```lua
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.

```lua
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.

```lua
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.

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

{% hint style="info" %}
Note that you can remove one of that elements or just don't include the  '**`OptionalData`**' table.&#x20;
{% endhint %}