Worktables icon

Worktables

Interact with Monday.com boards and items

Actions26

Overview

This node interacts with Monday.com boards and their components via the Monday.com API. Specifically, the "List Board's Groups" operation retrieves all groups within a specified board. This is useful for workflows that need to organize or analyze the structure of a board by its groups, such as automating reporting on group statuses, syncing group data with other systems, or managing group-level permissions.

Practical example: You might use this node to fetch all groups in a project management board to generate a summary report of each group's progress or to trigger actions based on group properties like archived or deleted status.

Properties

Name Meaning
Workspace Name or ID Select the workspace containing the board. Choose from the list or specify an ID via expression.
Board Kind Filter boards by kind: All, Public, Private, or Shareable.
Order By The order to retrieve boards: None, Name (created_at), or Newest (used_at).
State Filter boards by state: All, Active, Archived, or Deleted.
Limit Maximum number of results to return. If 0, all boards are returned.
Board Name or ID Select the specific board to list groups from. Choose from the list or specify an ID via expression.
Archived Whether to include archived groups in the listing (boolean).
Deleted Whether to include deleted groups in the listing (boolean).

Note: For the "List Board's Groups" operation, the relevant properties are primarily Workspace Name or ID, Board Name or ID, Board Kind, Order By, State, Limit, Archived, and Deleted.

Output

The output JSON contains an array of groups belonging to the specified board. Each group object includes:

  • id: The unique identifier of the group.
  • title: The name/title of the group.
  • color: The color assigned to the group.
  • position: The position/order of the group within the board.
  • archived (optional): Indicates if the group is archived (present if requested).
  • deleted (optional): Indicates if the group is deleted (present if requested).

Example output snippet:

[
  {
    "id": "group1",
    "title": "To Do",
    "color": "#c4c4c4",
    "position": 1,
    "archived": false,
    "deleted": false
  },
  {
    "id": "group2",
    "title": "In Progress",
    "color": "#fdab3d",
    "position": 2,
    "archived": false,
    "deleted": false
  }
]

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for Monday.com (referred generically as "an API key credential").
  • The node makes HTTP POST requests to the Monday.com GraphQL API endpoint at https://api.monday.com/v2.
  • Proper configuration of the API key credential in n8n is necessary for authentication.
  • The workspace and board IDs must be valid and accessible by the authenticated user.

Troubleshooting

  • API Key Not Found: The node throws an error if the API key credential is missing or invalid. Ensure the API key is correctly configured in n8n credentials.
  • Board ID Required: The operation requires a valid board ID. If not provided or invalid, the node will throw an error.
  • Permission Issues: If the API key does not have access to the specified workspace or board, the request will fail. Verify permissions in Monday.com.
  • Empty Results: If no groups are returned, verify that the board has groups and that filters like archived/deleted flags are set appropriately.
  • Network Errors: Connectivity issues to the Monday.com API endpoint can cause failures. Check network connectivity and proxy settings if applicable.

Links and References

Discussion