View as Markdown
monday icon

monday ACTION

List Boards

List boards with their full details — columns, groups, owners, subscribers, tags and workspace. Use when you need board metadata; use List Board ID Options when you only need an ID and a name, which returns a far smaller response. Narrow the results with Board IDs, Workspace IDs, Board Kind and State. Example: Limit 25, Page 1, State active. Returns an array of board objects. If exactly Limit boards come back there are probably more — call again with Page incremented by 1. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's monday account once, then configure and run List Boards from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "monday-list-boards",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    monday: { authProvisionId: "apn_xxxxxxx" },
    boardIds: ["Board IDs"],
    workspaceIds: [10],
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Boards inputs
Property Type Description
boardIds Board IDs string[]
Return only these boards, as an array of board IDs. Use List Board ID Options to find valid IDs. Omit to return all boards.
Optional Dynamic
workspaceIds Workspace IDs integer[]
Restrict the results to boards in these workspaces, as an array of workspace IDs. Use List Workspace IDs Options to look up workspace IDs by name. Omit to include every workspace.
Optional Dynamic
boardKind Board Kind string
Filter the results to boards of a specific kind (public / private / share)
Optional
state State string
Filter the results to boards in a specific state (active / archived / deleted / all). Defaults to all.
Optional
orderBy Order By string
The field to sort results by (created_at / used_at). Defaults to created_at.
Optional
limit Limit integer
The maximum number of boards to return per page. Defaults to 25. If exactly this many boards are returned there are probably more, so call again with Page incremented by 1.
Optional
page Page integer
The page number to return, starting at 1. Increment this to walk through boards when a call returns a full page of Limit results.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
monday-list-boards
Version
0.0.4
App
monday
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes