---
title: "getBoard"
canonical: "https://support.appfire.com/space/CSOAP/1493042838/getBoard"
format: markdown
---
> Macro (aura-html)

See also: [Agile Client Actions](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/1493042328)

> Macro (details)
> 
> | **Description** | Get information about a board by board id or name. |
> | --- | --- |
> | **Required Parameters** | [board](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/1493043986) |
> | **Optional Parameters** | [type](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68458978), [outputType](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68459055), [file](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68455055), [append](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68454814), [encoding](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68458746) |
> | **Type** | [Get](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68455033/Action+Types#ActionTypes-Get) |
> | **Category** | [Boards](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68455044/Action+Categories#ActionCategories-Boards) |
> | **Output Formats** |  |
> | **Replacement Variables** | board, boardId |
> | **Hosting** | cloud,server,datacenter |
> | **Since Version** |  |
> | **Examples** | [getBoard](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/1493044230/Agile+Client+Examples#getBoard) |

## Related How To's

> Macro (cql-query)