Learn how to read, create, update, and delete monday.com board views using the platform API
monday.com board views allows you to visualize your board data differently. The API can provide records of all views added to a board (except for dashboard views).
Queries
- Returns an array containing metadata about a collection of board views from a specific board
- Can only be nested inside a
boards
query
query {
boards (ids: 1234567890) {
views {
type
settings_str
view_specific_data_str
name
id
}
}
}
import { ApiClient } from "@mondaydotcomorg/api";
const mondayApiClient = new ApiClient({ token: myToken });
const query = `query ($board: [ID!]) { boards (ids: $board) { views { id name type } } }`
const variables = {
board: 1234567
}
const response = await mondayApiClient.request(query, variables);
Arguments
You can use the following argument(s) to reduce the number of results returned in your views
query.
Argument | Description |
---|---|
ids [ID!] | The specific board IDs to return views for. |
type String | The specific type of views to return. |
Fields
You can use the following field(s) to specify what information your views
query will return.
Field | Description | Enum values |
---|---|---|
access_level BoardViewAccessLevel! | The user's board view access level. | edit view |
filter JSON | The view's filter metadata. Only available in API versions 2025-10 and later. | |
filter_team_id Int | The team ID the view is filtered by. Only available in API versions 2025-10 and later. | |
filter_user_id Int | The user ID the view is filtered by. Only available in API versions 2025-10 and later. | |
id ID! | The view's unique identifier. | |
name String! | The view's name. | |
settings JSON | The view's settings. The structure varies by view type. Only available in API versions 2025-10 and later. | |
settings_str String! | The view's settings. | |
sort JSON | The view's sort metadata. Only available in API versions 2025-10 and later. | |
source_view_id ID | The unique identifier of the original view this was duplicated from (if applicable). | |
tags [String!] | The view's tags. Only available in API versions 2025-10 and later. | |
type String! | The view's type. | |
view_specific_data_str String! | Specific board view data (only supported for forms). |
Delete a board view
🚧 Only available in API versions 2025-10 and later
Required scope: boards:write
The delete_view
mutation allows you to delete a board view via the platform API. You can also specify what fields to query back from the tag when you run the mutation.
mutation {
delete_view (board_id: 1234567890, view_id: 54321) {
name
}
}
Arguments
You can use the following argument(s) to specify which board view to delete.
Argument | Description |
---|---|
board_id ID! | The board's unique identifier. |
view_id ID! | The view's unique identifier. |