1. Overview
Monday is a comprehensive work operating system that enables teams to run projects and workflows with complete confidence. It provides a flexible platform for project management, task tracking, and team collaboration through customizable boards, columns, and items.
Through GoInsight's Monday node, you can seamlessly integrate Monday.com operations into your automation workflows. You can achieve complete lifecycle management of boards, groups, items, and columns, including:
- Create and manage boards with custom configurations and permissions.
- Organize work by creating groups and columns to structure your boards.
- Track progress by creating, updating, and managing items within groups.
- Collaborate effectively by adding updates and managing item data.
2. Prerequisites
Before using this node, you need to have a valid Monday account. You may need administrator or specific permissions to create and manage API credentials. Additionally, ensure you have access to the boards and workspaces you want to manage through the API.
3. Credentials
For detailed guidance on how to obtain and configure credentials, please refer to our official documentation: Credentials Configuration Guide.
4. Supported Operations
This Monday node provides comprehensive functionality for managing all core resources in your Monday.com workspace. The operations are organized around four main resource types: Boards, Groups, Items, and Columns.
Summary
Resource | Operation | Description |
---|---|---|
Board | Create a Board | Creates a new board in Monday.com with specified name, type, and optional workspace placement. |
Board | Get a Board | Retrieves a board from Monday.com by its ID. |
Board | Get many Boards | Retrieves multiple Monday.com boards specified by their board IDs. |
Board | Archive a Board | Archives a specified board on monday.com by its board ID. |
Group | Create a Board Group | Creates a new group on a specified Monday.com board for organizing items. |
Group | Get many Board Groups | Retrieve all group details of a specified Monday.com board. |
Group | Delete a Board Group | Deletes a group on a specified Monday.com board. |
Column | Create a Board Column | Creates a new column on a Monday.com board with the specified title and type. |
Column | Get many Board Columns | Retrieves all columns on a specified Monday.com board. |
Column | Change a Column Value for a Board Item | Changes the value of a specific column in a specified item on a Monday.com board. |
Column | Change Multiple Column Values for a Board Item | Changes multiple column values for a specified item on a Monday.com board in a single operation. |
Item | Create an Item in a Board's Group | Creates a new item in a specified group within a Monday.com board. |
Item | Get an Item | Retrieves a specific item by its ID from Monday.com board, including its basic details and column values. |
Item | Get many Items | Retrieves multiple items by their IDs from a Monday.com board, including their basic details and column values. |
Item | Get Items Item by Column Value | Retrieves items from a Monday.com board that match a specified column value. |
Item | Delete an Item | Deletes a specified item on Monday.com, this action cannot be undone. |
Item | Move an Item to a Group | Moves a specified item to a different group on a Monday.com board, this action cannot be undone. |
Item | Add an Update to an Item | Adds a new update to a specified item on Monday.com. |
Operation Details
Create a Board
Creates a new board in Monday.com with specified name, type, and optional workspace placement.
Input Parameters:
- BoardName: The name of the board to create.
- BoardKind: The type of the board. Valid values: "public", "private", "share".
Output:
- BoardId (string): The ID of the newly created board.
- BoardName (string): The name of the newly created board.
- StatusCode (number): Operation result code: 200 (success), 500 (request failed), -1 (parameter error).
- ErrorMessage (string): Error message if any error occurred, empty when successful.
Create a Board Column
Creates a new column on a Monday.com board with the specified title and type.
Input Parameters:
- BoardId: The ID of the board where the column will be created.
- Title: The title of the new column.
- ColumnType: The type of the column to create (e.g., "text", "status", "date").
Output:
- ColumnId (string): The ID of the newly created column.
- StatusCode (number): Operation result code: 200 for success; 500 for API error; -1 for parameter validation error.
- ErrorMessage (string): Error message if an error occurred; empty otherwise.
Create a Board Group
Creates a new group on a specified Monday.com board for organizing items.
Input Parameters:
- BoardId: The ID of the board where the group will be created.
- GroupName: The name of the group to be created.
- GroupColor: The color of the group, support color names or HEX values.exp, name:pink,red; HEX:#ff5ac4,#e2445c
Output:
- GroupId (string): The ID of the newly created group.
- StatusCode (number): Operation result code: 200 for success; 500 for API error; -1 for parameter validation error.
- ErrorMessage (string): Error message if an error occurred; empty otherwise.
Create an Item in a Board's Group
Creates a new item in a specified group within a Monday.com board.
Input Parameters:
- BoardId: The ID of the board in which to create the item.
- GroupId: The ID of the group within the board where the item will be created.
- ItemName: The name/title of the new item to create.
Options:
- ColumnValues: A JSON string specifying column values to set upon creation. Pass an empty string if no values.
Output:
- ItemId (string): The unique identifier of the newly created item.
- StatusCode (number): Operation status code: 200 for success, 500 for API/internal error, -1 for parameter validation error.
- ErrorMessage (string): Error message if any; empty if operation succeeds.
Delete a Board Group
Deletes a group on a specified Monday.com board.
Input Parameters:
- BoardId: The ID of the board containing the group.
- GroupId: The ID of the group to be deleted.
Output:
- Deleted (bool): Indicates whether the group was successfully deleted.
- StatusCode (number): Operation status code: 200 for success; 500 for API error; -1 for parameter validation error.
- ErrorMessage (string): Error message if an error occurred; empty otherwise.
Delete an Item
Deletes a specified item on Monday.com, this action cannot be undone.
Input Parameters:
- ItemId: The ID of the item to be deleted.
Output:
- DeletedItemId (string): The unique identifier of the deleted item.
- StatusCode (number): Overall operation status code: 200 for success, -1 for parameter validation error, 500 for API/internal error.
- ErrorMessage (string): Error message if any; empty if operation succeeds.
Get Items Item by Column Value
Retrieves items from a Monday.com board that match a specified column value.
Input Parameters:
- BoardId: The ID of the board to query.
- ColumnId: The ID of the column to filter by.
- ColumnValue: The value to match in the specified column.
Output:
- Items (object-array): A list of item objects matching the filter. Each object contains:Id Name and ColumnValues
- StatusCode (number): Operation status code: 200 for success, -1 for parameter validation error, 500 for API/internal error.
- ErrorMessage (string): Error message if any; empty if operation succeeds.
Get a Board
Retrieves a board from Monday.com by its ID.
Input Parameters:
- BoardId: The ID of the board to retrieve.
Output:
- BoardId (string): The ID of the retrieved board.
- BoardName (string): The name of the retrieved board.
- StatusCode (number): Operation result code: 200 (success), 500 (request failed), -1 (parameter error).
- ErrorMessage (string): Error message if any error occurred, empty when successful.
Get an Item
Retrieves a specific item by its ID from Monday.com board, including its basic details and column values.
Input Parameters:
- ItemId: The ID of the item to retrieve.
Output:
- Id (string): The unique identifier of the retrieved item.
- Name (string): The name of the retrieved item.
- BoardId (string): The ID of the board containing the item.
- GroupId (string): The ID of the group containing the item.
- ColumnValues (object-array): A list of column value objects, each with fields: Id, Title, Text, Value.
- StatusCode (number): Operation status code: 200 for success, -1 for parameter validation error, 500 for API/internal error.
- ErrorMessage (string): Error message if any; empty if operation succeeds.
Get many Board Columns
Retrieves all columns on a specified Monday.com board.
Input Parameters:
- BoardId: The ID of the board to retrieve columns for.
Output:
- Columns (string): A JSON string list of column objects with fields: id, title, type, settings_str.
- StatusCode (number): Overall operation status code: 200 for success; 500 for API error; -1 for parameter validation error.
- ErrorMessage (string): Error message if an error occurred; empty otherwise.
Get many Board Groups
Retrieve all group details of a specified Monday.com board.
Input Parameters:
- BoardId: The ID of the board to retrieve group information from.
Output:
- Groups (object-array): A list of group objects returned by the API. Each object contains:
- StatusCode (number): Operation status code: 200 for success, -1 for invalid parameters, 500 for API or internal errors.
- ErrorMessage (string): Error description if any; empty if the operation succeeds.
Get many Boards
Retrieves multiple Monday.com boards specified by their board IDs.
Input Parameters:
- BoardIds: A comma-separated list of board IDs to retrieve.
Output:
- Results (string): A JSON string list of board objects, each containing the fields: id, name, description, state.
- StatusCode (number): Operation result code: 200 (success), 500 (API error), -1 (parameter validation error).
- ErrorMessage (string): Error message if any; empty if no errors.
Get many Items
Retrieves multiple items by their IDs from a Monday.com board, including their basic details and column values.
Input Parameters:
- ItemIds: A comma-separated list of Monday.com item IDs to retrieve.
Output:
- Items (object-array): A list of item objects retrieved. Each object contains:Id Name BoardId GroupId ColumnValues
- StatusCode (number): Operation result code: 200 (success), 500 (request failed), -1 (parameter error).
- ErrorMessage (string): Error message if any error occurred, empty when successful.
Archive a Board
Archives a specified board on monday.com by its board ID.
Input Parameters:
- BoardId: The ID of the board to archive.
Output:
- ArchivedBoardId (string): The ID of the board that was archived.
- StatusCode (number): Operation result code: -1 indicates parameter error, 200 indicates success, 500 indicates API or GraphQL error, or other HTTP error codes.
- ErrorMessage (string): Error message describing the failure, empty if operation successful.
Change Multiple Column Values for a Board Item
Changes multiple column values for a specified item on a Monday.com board in a single operation.
Input Parameters:
- BoardId: The ID of the board containing the item.
- ItemId: The ID of the item whose columns will be updated.
- ColumnValues: A JSON string mapping column IDs to their new values, following Monday.com's column value schema.
Output:
- ColumnValuesId (string): The unique identifier of the change operation returned by the mutation.
- StatusCode (number): Overall operation status code: 200 for success, 500 for API or internal error, -1 for parameter validation error.
- ErrorMessage (string): Error message if any; empty if the operation succeeds.
Change a Column Value for a Board Item
Changes the value of a specific column in a specified item on a Monday.com board.
Input Parameters:
- BoardId: The ID of the board containing the item.
- ItemId: The ID of the item whose column will be updated.
- ColumnId: The ID of the column to change.
- ColumnValue: A JSON string representing the new value for the column, as defined by Monday.com's column value schema.
Output:
- ColumnValueId (string): The unique identifier of the changed column value entry returned by Monday.com API.
- StatusCode (number): Operation status code: 200 for success, -1 for parameter validation error, 500 for API/internal error.
- ErrorMessage (string): Error message if any; empty if operation succeeds.
Move an Item to a Group
Moves a specified item to a different group on a Monday.com board, this action cannot be undone.
Input Parameters:
- ItemId: The ID of the item to move.
- GroupId: The ID of the target group to which the item will be moved.
Output:
- MovedItemId (string): The ID of the moved item returned by the mutation.
- StatusCode (number): Overall operation status code: 200 for success, -1 for parameter validation error, 500 for API/internal error.
- ErrorMessage (string): Error message if any; empty if operation succeeds.
Add an Update to an Item
Adds a new update to a specified item on Monday.com.
Input Parameters:
- ItemId: The ID of the item to which the update will be added.
- UpdateText: The body text of the update to be added.
Output:
- UpdateId (string): The unique identifier of the newly created update.
- StatusCode (number): Operation status code: 200 for success, 500 for API/internal error, -1 for parameter validation error.
- ErrorMessage (string): Error message if any; empty if operation succeeds.
5. Example Usage
This section will guide you through creating a simple workflow to create a new board in your Monday.com workspace. This example demonstrates the foundational step for setting up project management within Monday.com.
The workflow consists of Start -> Monday -> Answer nodes, where we'll use the "Create a Board" operation to establish a new project board.
Step-by-step guide:
- Add the tool node:
- In the workflow canvas, click the "+" button to add a new node.
- In the popup panel, select the "Tools" tab.
- Find and select Monday from the tools list.
- In the Monday supported operations list, click and select Create a Board, which will add a corresponding node to the canvas.
- Configure the node:
- Click on the newly added Create a Board node, and the configuration panel will expand on the right side.
- Credential Configuration: At the top of the panel, find the credential field. Click the dropdown menu and select your pre-configured Monday credentials.
- Parameter Configuration:
- BoardName: Enter a name for your new board, for example "Marketing Campaign Q4".
- BoardKind: Specify the board type. Enter "public" for a public board, "private" for a private board, or "share" for a shared board.
- Run and verify:
- Once all required parameters are properly filled, the error indicators in the top right corner of the workflow canvas will disappear.
- Click the "Test Run" button in the top right corner of the canvas to execute the workflow.
- After successful execution, you can click the log icon in the top right corner to view detailed input and output of the node, verifying that the operation was successful.
After completing these steps, your entire workflow will be configured. Click "Test Run" and a new board will be successfully created in your Monday.com workspace with the specified name and type.
6. FAQs
Q: I'm getting a 401 or 403 error when trying to access Monday.com API. What should I do?
A: This typically indicates an authentication or permission issue. Please check the following:
- Verify that your API token is correctly configured in the credentials.
- Ensure your Monday.com account has the necessary permissions to perform the requested operation.
- Check if your API token has expired and needs to be regenerated.
Q: Why am I getting a parameter validation error (-1 status code)?
A: Parameter validation errors occur when required fields are missing or have invalid values. Please ensure:
- All required parameters are filled with valid data.
- Board IDs, Item IDs, and Group IDs are valid and exist in your Monday.com workspace.
- JSON strings for column values follow Monday.com's expected schema format.
Q: How do I find the IDs for boards, groups, and items?
A: You can obtain these IDs through several methods:
- Use the "Get many Boards" operation to retrieve all your board IDs.
- Use "Get many Board Groups" with a board ID to get all group IDs within that board.
- Use "Get many Items" to retrieve item IDs from your boards.
- Check the Monday.com web interface URL when viewing specific items - the ID is often visible in the URL.
Q: What column types are supported when creating columns?
A: Monday.com supports various column types including "text", "status", "date", "numbers", "person", "timeline", "dropdown", and many others. Refer to Monday.com's official documentation for the complete list of supported column types and their specific configuration requirements.
7. Official Documentation
For more detailed information about Monday.com's API capabilities and advanced features, please refer to the Monday Official API Documentation.
Leave a Reply.