---
title: "getBoardId"
canonical: "https://support.appfire.com/space/PSJC/567312453/getBoardId"
format: markdown
---
> Macro (aura-html)


## Description

> Macro (excerpt)
> 
> Used to obtain the unique identifier (ID) associated with a specific board.

Used to obtain the unique identifier (ID) associated with a specific board. The ID is essential for performing various actions related to the board.

|  |  |  |  |
| --- | --- | --- | --- |
| **Syntax** | getBoardId(partial_board_name)  
or  
findBoard(partial_board_name) | **Package** |  |
| **Alias** |  | **Pkg Usage** |  |

## Parameters

| Parameter name | Type | Required | Description |
| --- | --- | --- | --- |
| partial_board_name | String | Yes | partial board name to search for |

## Return Type

**Integer**

Returns the first board that matches. If return is null, it means no board was found

## Example

```javascript
return getBoardId("Sprint delta tiger force alpha");
```

## See also

> Macro (contentbylabel)