Boards
Retrieves a collection of boards, including their details and associated data.
Table-Specific Information
SELECT
The cmdlet uses the Monday API to process some of the filters. The cmdlet processes other filters client-side within the cmdlet.
- Id supports the =, IN comparison operators.
- BoardKind supports the = comparison operator.
- State supports the = comparison operator.
- WorkspaceId supports the =, IN comparison operators.
For example, the following queries are processed server-side:
SELECT * FROM Boards WHERE Id = '2181960030'
SELECT * FROM Boards WHERE Id IN ('2307103055', '2182296646', '2181960030')
SELECT * FROM Boards WHERE BoardKind = 'public'
SELECT * FROM Boards WHERE State = 'Val1'
SELECT * FROM Boards WHERE WorkspaceId = '1345997021'
INSERT
The following columns can be used to create a new record: Name, Description, BoardKind, BoardFolderId, and WorkspaceId.
The following pseudo-columns can be used to create a new record: ItemNicknamePlural, ItemNicknamePresetType, ItemNicknameSingular, TemplateId, BoardOwnerIds, BoardOwnerTeamIds, BoardSubscriberIds, BoardSubscriberTeamIds, and Empty.
UPDATE
The following columns can be updated: Name, Description, Communication, and State.
The following pseudo-column can be used to update a record: BasicRoleName.
DELETE
You can delete entries by specifying the following column: Id.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A unique identifier for the board, used to distinguish it from other boards in the system. | |
| CreatorId | String | True |
Users.Id |
The unique identifier of the user who created the board. |
| Name | String | False |
The name of the board, representing its primary label or title. | |
| ItemTerminology | String | True |
Defines the terminology used for items on the board. Can be a predefined term or a custom value provided by the user. | |
| ItemsCount | Int | True |
The total number of items currently present on the board. | |
| TopGroupId | String | True |
Groups.Id |
The unique identifier of the top-level group associated with this board. |
| Description | String | False |
A detailed description or summary of the board's purpose or content. | |
| UpdatedAt | Datetime | True |
The timestamp indicating when the board was last updated. | |
| Type | String | True |
Specifies the type of board object, such as a task board or project board. | |
| Url | String | True |
The direct URL link to access the board. | |
| BoardKind | String | True |
Indicates the kind of board, such as public, private, or shared, determining its visibility and access. The allowed values are public, private, share. | |
| BoardFolderId | String | True |
Folders.Id |
A unique identifier for the board's folder within the system. |
| Communication | String | False |
Specifies the communication identifier associated with the board, typically a meeting ID or collaboration reference. | |
| Permissions | String | True |
Defines the permissions or access controls assigned to the board. | |
| TagsIds | String | True |
Tags.Id |
A comma-separated list of unique identifiers for the tags associated with the board. |
| State | String | False |
Indicates the current state of the board, such as 'all', 'active', 'archived', or 'deleted'. | |
| WorkspaceId | String | True |
Workspaces.Id |
The unique identifier of the workspace containing the board. A null value indicates the board belongs to the main workspace. |
| AccessLevel | String | True |
The user's board permission level. | |
| ObjectTypeUniqueIdentifier | String | True |
A unique identifier for the board's object type. | |
| CreatedAt | Datetime | False |
The date and time when the board was created. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| ItemNicknamePlural | String |
The plural form of the item nickname. |
| ItemNicknamePresetType | String |
The preset type for item nickname. |
| ItemNicknameSingular | String |
The singular form of the item nickname. |
| TemplateId | String |
Specifies the unique identifier of an optional template used to create the board. |
| BoardOwnerIds | String |
An optional, comma-separated list of user IDs representing the owners of the board. |
| BoardOwnerTeamIds | String |
An optional, comma-separated list of team IDs representing the owner teams of the board. |
| BoardSubscriberIds | String |
An optional, comma-separated list of user IDs representing subscribers to the board. |
| BoardSubscriberTeamIds | String |
An optional, comma-separated list of team IDs representing subscriber teams to the board. |
| Empty | Bool |
An optional flag indicating whether to create an empty board without any default items. |
| BasicRoleName | String |
The role's name. |