Browse the manual

Board, card and file tools

Read boards and files and prepare permitted changes for review.

On this page

For: developers connecting an HTTP or MCP client. Start with Agent API and AI clients.

AI is optional. You confirm invoice issuance in Pepper.

Boards and cards

The HTTP and MCP tools use the delegated person’s current Use boards permission and board membership. Private boards stay absent for installation admins until they explicitly recover access in the app. Linked record details require their own access. Read tools need boards:read; preparation needs boards:prepare.

MCP tool HTTP path after /api/v1/ Result
boards_list GET boards Up to 30 permitted boards; send page until next_page is null
boards_get GET boards/{id} Board, lists and the first 40 cards per list
cards_list GET board-lists/{id}/cards Next 40 cards; pass the previous next cursor as after
cards_get GET board-cards/{id} Card, current version, fields and permitted source details
boards_prepare POST boards/prepare Editable browser review link; writes no board or card

For boards_list, search filters titles and archived=true includes archived boards. boards_get returns later-page cursors in more, keyed by list ID.

boards_prepare requires operation, payload and idempotency_key:

  • create_board: payload title and template (ideas, project, kanban, weekly, announcements, retrospective or client).
  • create: board_id, and payload list_id with title or source: {type, id}. Optional description and due_at.
  • update: card_id, and payload version with any of title, description, starts_at or due_at.
  • move: card_id, destination board_id, and payload version and list_id.

Dates use YYYY-MM-DD; update dates can be null. Read the current version before preparing an update or move. Open review_url, review the editable values and save in the app. Observers cannot prepare edits. A stale version returns 409. There is no agent execution endpoint for these proposals.

See Boards and cards.

Files

The tools use the delegated person's current file permissions and record access. A file attached only to records outside that access is absent. Read tools need files:read and See files; preparation needs files:prepare and Upload and change files.

MCP tool HTTP path after /api/v1/ Result
files_list GET files A folder's subfolders, then its files, 100 files per page. Pass folder_id for a folder, search for names in every folder, and page until next_page is null
files_get GET files/{id} The file's folder, current version, version list and the records it is attached to within access. Returns no bytes
files_read_text GET files/{id}/text The text of a plain text, CSV, Markdown, HTML, CSS, JavaScript, JSON, XML or YAML file up to 1 MB, and its version ID. Pass version_id for an earlier version. Reading counts as a download
files_prepare_text_version POST files/{id}/text/prepare A review link for new text; writes no version

files_prepare_text_version requires base_version_id (from files_read_text), the complete new content (UTF-8, up to 1 MB) and idempotency_key. The same checks as a save in the editor apply, including valid JSON and XML. If a newer version exists, the call returns 409 with who saved it. Open review_url: the person sees the proposed text in the editor, compares it and saves it as a new version, or closes it without saving. There is no agent execution endpoint for these proposals.

See Edit text files.

Need help with the product?

Contact support