Skip to content

List boards

The workspace's boards, A to Z: each with its id, name, how many videos it holds, its app URL and its share_url when its public share link is on (null when off). The ids and exact names are what the board endpoints take, with the same workspace. Same answer as the MCP tool list_boards. Never counted against the allowance, as its MCP tool; the account still needs a plan (402 no_plan without one).

get/api/v1/boards

Authentication

OAuth token, API key or signed-in session, sent as Authorization: Bearer <token> (a session rides on its cookie). An OAuth token needs mcp:read. See authentication.

Query parameters

  • workspacestring

    Optional: the workspace's id or exact name, from List workspaces. Without it, the current workspace (the one the account last opened in the app). Every answer names the workspace it acted in. 1 to 120 characters.

Response fields

  • boardsarray of Board

    Each with id, name, videos, url, share_url.

  • urlstring (uri)

    The workspace's boards in the app.

  • workspaceobject

    The workspace the request read or changed.

Responses

  • 200

    A workspace's boards. Body: BoardList.

  • 400

    A parameter is malformed or not supported, or workspace is empty, repeated or too long. Body: Problem.

  • 401

    No account: send an API key, an OAuth access token or a session cookie. WWW-Authenticate names the protected-resource metadata. Body: Problem.

  • 402

    no_plan: the account has no plan, and the API comes with one. Body: Problem.

  • 403

    The token lacks mcp:read. workspace_locked: the workspace is past the plan's workspaces, so nothing was read or changed; use an open one (List workspaces marks the locked ones). Body: Problem.

  • 404

    No such niche, format, brand, creator, page or endpoint. workspace_not_found: the organization has no workspace with that id or name (List workspaces lists them). Body: Problem.

  • 429

    Rate limit exceeded; wait Retry-After seconds. Body: Problem.

  • 500

    The request failed on our side. Body: Problem.