monday.com boards are where users input all of their data. As such, it is one of the core components of the platform, and one of the main objects you will need to be familiar with.

A board’s structure is composed of rows (called items), groups of rows (called groups), and columns. The data of the board is stored in the items on the board as well as in the updates sections of each item. Each board has one or more owners and subscribers.

Additionally, there are three different board types (main, shareable, and private) and each board can have different sets of permissions.

Boards queries

Required scope: boards:read

You can use boards at the root of your query, or you can nest them within another query to return something. Querying boards can return one or a collection of boards.

query {
  boards (ids: 12345678) {
    name
    state
    board_folder_id
    items (limit:100) {
      id
      name
      column_values {
        text
      }
    }
  }
}

let query = 'query { boards (ids: 12345678) { name state board_folder_id owner { id }}}';

fetch ("https://api.monday.com/v2", {
  method: 'post',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YOUR_API_KEY_HERE'
   },
   body: JSON.stringify({
     'query' : query
   })
  })
   .then(res => res.json())
   .then(res => console.log(JSON.stringify(res, null, 2)));

Arguments

The following board arguments can reduce the number of boards returned.

Fields

Fields are used to return specific properties in an object. The following fields will determine what information is returned from your boards query. Some fields will have their own arguments.

Boards mutations

Required scope: boards:write

Create a board

🚧

Mutation-specific rate limit

The create_board mutation has an additional rate limit of 40 mutations per minute. If you exceed this limit, you will receive 429 HTTP response code with a "Call limit exceeded for CreateBoard" error message.

This method allows you to create a new board. After the mutation runs you can query back all the board data as shown in the querying boards section above.

To see the template ID's for your personal templates, activate the "Developer Mode" feature in your monday.labs. You will then be able to see your template ID's in the template preview screen. For our built-in templates, the template ID will be the board ID of the board created from the template.

mutation {
    create_board (board_name: "my board", board_kind: public) {
        id
    }
}

let query = 'mutation { create_board (board_name: \"my board\", board_kind: public) {   id }}';

fetch ("https://api.monday.com/v2", {
  method: 'post',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YOUR_API_KEY_HERE'
   },
   body: JSON.stringify({
     'query' : query
   })
  })
   .then(res => res.json())
   .then(res => console.log(JSON.stringify(res, null, 2)));

You can find the Postman request to create a board here.

Arguments for create a board

The following arguments define the new board's characteristics.

📘

NOTE

When creating a private or shareable board, the user that creates the board via API will be added as the board's owner automatically. This will also be the case if the argument board_owner_ids is not used.

Archive a board

This method allows you to archive a board. After the mutation runs you can query back all the board data as shown in the querying boards section above.

mutation {
    archive_board (board_id: 123456789) {
        id
    }
}

let query = 'mutation { archive_board (board_id: 123456789) { id }}';

fetch ("https://api.monday.com/v2", {
  method: 'post',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YOUR_API_KEY_HERE'
   },
   body: JSON.stringify({
     'query' : query
   })
  })
   .then(res => res.json())
   .then(res => console.log(JSON.stringify(res, null, 2)));

Arguments for archive a board

The following argument determines which board will be archived.

Duplicate a board

🚧

Mutation-specific rate limit

The duplicate_board mutation has an additional rate limit of 40 mutations per minute. If you exceed this limit, you will receive 429 HTTP response code with a "Call limit exceeded for DuplicateBoard" error message.

This method allows you to duplicate a board. After the mutation runs you can query back all the board data as shown in the querying boards section above.

This mutation duplicates a board with all of its items and groups to a specific workspace and/or folder of your choice.

This query will return data of the board created as well as whether the process is synchronous or asynchronous. Please note that an asynchronous duplication process may take some time to complete, therefore the initial returned data may be partial.

mutation {
    duplicate_board(board_id:123456789, duplicate_type: duplicate_board_with_structure) {
        board {
            id
        }
    }
}

let query = 'mutation { duplicate_board(board_id:123456789, duplicate_type: duplicate_board_with_structure) { board { id }}}';

fetch ("https://api.monday.com/v2", {
  method: 'post',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YOUR_API_KEY_HERE'
   },
   body: JSON.stringify({
     'query' : query
   })
  })
   .then(res => res.json())
   .then(res => console.log(JSON.stringify(res, null, 2)));

Arguments for duplicate a board

The following arguments define the type of board duplication.

Update a board

This method allows you to update a board.

mutation {
  update_board(board_id: 123456789, board_attribute: description, new_value: "This is my new description")
}

let query = 'mutation { update_board(board_id: 123456789, board_attribute: description, new_value: "This is my new description")}';

fetch ("https://api.monday.com/v2", {
  method: 'post',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YOUR_API_KEY_HERE'
   },
   body: JSON.stringify({
     'query' : query
   })
  })
   .then(res => res.json())
   .then(res => console.log(JSON.stringify(res, null, 2)));

Arguments for update board

The following arguments determine which board to update and specify the new value.

Delete a board

This method allows you to delete a board.

mutation {
    delete_board (board_id: 123456789) {
        id
    }
}

let query = 'mutation { delete_board (board_id: 123456789) { id }}';

fetch ("https://api.monday.com/v2", {
  method: 'post',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YOUR_API_KEY_HERE'
   },
   body: JSON.stringify({
     'query' : query
   })
  })
   .then(res => res.json())
   .then(res => console.log(JSON.stringify(res, null, 2)));

Arguments for delete a board

The following argument determines which board will be deleted.

Add teams to a board

This method allows you to add a teams to a board.

mutation {
  add_teams_to_board (board_id:123456789, team_ids: [12345,54321]) {
    id
    name
  }
}

let query = 'mutation { add_teams_to_board (board_id: 123456789, team_ids: [12345,54321]) { id } }';

fetch ("https://api.monday.com/v2", {
method: 'post',
headers: {
'Content-Type': 'application/json',
'Authorization' : 'YOUR_API_KEY_HERE'
},
body: JSON.stringify({
'query' : query
})
})
.then(res => res.json())
.then(res => console.log(JSON.stringify(res, null, 2)));

Arguments for add teams to a board

The following arguments define the teams to add to the board.

Add users to a board

This method allows you to add users to a board.

You can define if the users will be added as regular subscribers or as owners of the board.

mutation {
    add_users_to_board (board_id: 123456789, user_ids: [123456, 234567, 345678], kind: owner) {
        id
    }
}

Arguments for add users to a board

The following arguments define the users added to the board.

Add subscribers to a board (DEPRECATED)

This method allows you to add subscribers to a board. After the mutation runs you can query back all the board data as shown in the querying boards section above.

You can define if the users will be added as regular subscribers or as owners of the board.

mutation {
    add_subscribers_to_board (board_id: 123456789, user_ids: [123456, 234567, 345678], kind: owner) {
        id
    }
}

let query = 'mutation { add_subscribers_to_board (board_id: 123456789, user_ids: [123456, 234567, 345678], kind: owner) { id } }';

fetch ("https://api.monday.com/v2", {
  method: 'post',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YOUR_API_KEY_HERE'
   },
   body: JSON.stringify({
     'query' : query
   })
  })
   .then(res => res.json())
   .then(res => console.log(JSON.stringify(res, null, 2)));

Arguments for add subscribers to a board

The following arguments define the subscribers added to the board.

Delete subscribers from a board

This method allows you to delete subscribers from a board. After the mutation runs you can query back all the board data as shown in the querying boards section above.

mutation {
    delete_subscribers_from_board(board_id: 123456789, user_ids: [123456, 234567, 345678]) {
        id
    }
}

let query = 'mutation { delete_subscribers_from_board(board_id: 123456789, user_ids: [123456, 234567, 345678]) { id }}';

fetch ("https://api.monday.com/v2", {
  method: 'post',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YOUR_API_KEY_HERE'
   },
   body: JSON.stringify({
     'query' : query
   })
  })
   .then(res => res.json())
   .then(res => console.log(JSON.stringify(res, null, 2)));

Arguments for delete subscribers from a board

The following arguments define the subscribers removed from the board.

📘

Have questions?

Join our developer community! You can share your questions and learn from fellow users and monday.com product experts.

Don’t forget to search before opening a new topic!