Worktables icon

Worktables

Interact with Monday.com boards and items

Overview

The "List Boards" operation of the Worktables node allows users to retrieve a list of boards from a specified workspace in Monday.com. This operation is useful for scenarios where you want to display, filter, or process multiple boards programmatically within an automation workflow. For example, you might use this node to:

  • Fetch all active project boards in a specific workspace to generate reports.
  • Retrieve public or private boards for auditing or synchronization with other tools.
  • List boards ordered by creation date or recent usage to prioritize tasks.

This operation supports filtering by board kind (public, private, shareable, or all), state (active, archived, deleted, or all), and ordering options, as well as limiting the number of results returned.

Properties

Name Meaning
Workspace Name or ID Select the workspace from which to list boards. You can choose from a dropdown or specify an ID using an expression.
Board Kind Filter boards by kind. Options: All, Public, Private, Shareable.
Order By The order in which to retrieve boards. Options: None, Name (created_at), Newest (used_at).
State Filter boards by their state. Options: All, Active, Archived, Deleted.
Limit Maximum number of boards to return. If set to 0, all boards will be returned. Minimum value is 1.

Output

The output is an array of JSON objects, each representing a board with the following fields:

  • id: The unique identifier of the board.
  • name: The name of the board.
  • boardKind: The kind of the board (e.g., public, private).
  • state: The current state of the board (active, archived, deleted).
  • description: Description text of the board.
  • itemsCount: Number of items on the board.
  • creator: Object containing the creator's id and name.
  • owners: Array of owners with their ids and names.
  • subscribers: Array of subscribers with their ids and names.
  • tags: Array of tags associated with the board.
  • workspaceId: The ID of the workspace the board belongs to.
  • updatedAt: Timestamp of the last update.
  • url: URL link to the board.

Example output item:

{
  "id": 123456,
  "name": "Project Alpha",
  "boardKind": "public",
  "state": "active",
  "description": "Board for Project Alpha tasks",
  "itemsCount": 42,
  "creator": { "id": 789, "name": "Alice" },
  "owners": [{ "id": 789, "name": "Alice" }],
  "subscribers": [{ "id": 101, "name": "Bob" }],
  "tags": [{ "id": 5, "name": "Urgent" }],
  "workspaceId": 555,
  "updatedAt": "2024-01-15T12:34:56Z",
  "url": "https://monday.com/boards/123456"
}

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 permissions on the API key are necessary to access workspaces and boards.
  • The workspace must exist and be 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 that the API key is correctly configured in n8n credentials.
  • Invalid Workspace ID: If the workspace parameter is incorrect or inaccessible, the request will fail. Verify the workspace ID or select it from the provided options.
  • Limit Parameter Issues: Setting limit to 0 returns all boards but may cause performance issues if there are many boards. Use with caution.
  • Permission Errors: If the API key lacks permission to read certain boards or workspaces, those boards will not appear in the results.
  • Network or API Errors: General HTTP or API errors should be checked by reviewing the error message and ensuring network connectivity and valid API endpoint.

Links and References

Discussion