Skip to content
MockFlow DevelopersGet an API key

Create a board table of typed records: rows and columns where each column has a type (text, number, single/multi select with coloured options, date, checkbox, URL, media links, votes, sticky-note c…

Updated 9 Nov 20263 min read

Send "type": "table".

Create a board table of typed records: rows and columns where each column has a type (text, number, single/multi select with coloured options, date, checkbox, URL, media links, votes, sticky-note cells). Use it for rosters, comparison tables, inventories, directories, idea lists the team votes on, retro columns and simple 2x2 or SWOT grids that collect sticky notes. NOT for spreadsheets needing formulas or calculations (use render_spreadsheet); NOT for tasks moving through stages (use render_kanban); NOT for elaborate strategy canvases like RACI, BCG, Ansoff or segmentation frameworks (use render_whiteboard).

Also available as the MCP tool render_table. The same payload works through either surface.

Fields

data
styleobject

Table styling.

Child attributes
themeenum<string>

Colours the header, grid and banded rows: clean = white, soft = light blue, mint = light green, peach = warm, bold = dark header, sticky = note yellow. One of clean, soft, mint, peach, bold or sticky.

bandedboolean

Alternate row tint.

bordersenum<string>

Grid lines. One of all, rows, outer or none.

compactboolean

Tighter rows.

fontSizenumber

Base text size in px, 12-22. 16 is normal.

fontenum<string>

sketchy = hand-drawn look. One of default or sketchy.

textColorstring

Default text colour as #RRGGBB.

scrollboolean

Keep the table at a set size with rows and fields scrolling inside, for data too long or wide to read at full size.

heightnumber

scroll only: visible height in px, 200-1200.

fieldsobject[]required

Columns, left to right.

Child attributes
namestringrequired
typeenum<string>required

One of text, number, select, multi, date, checkbox, url, media, icon, votes, stickies or person.

widthnumber

Column width in px, 60-400.

optionsobject[]

select/multi only.

summaryenum<string>

number only: footer total. One of sum, avg, count or none.

rowHeadersboolean

Style this column as bold row labels.

imageSizeenum<string>

media and icon only. One of s, m or l.

voteLimitnumber

votes only: votes per person, 0 = unlimited.

alignenum<string>

One of left, center or right.

formatobject

number only: how values display. Values stay bare numbers.

dateFormatenum<string>

date only. One of short, weekday, long, numeric or iso.

rowsany[]required

Records. Each row is an array with one value per field (text/url string, number number, select option label, multi array of labels, date YYYY-MM-DD, checkbox boolean, media array of image or YouTube URLs, stickies array of short note texts, votes [], person "" and icon "" which are filled in on the board), or {"cells": [...], "fill": "#RRGGBB"} to highlight the row. Any cell may instead be {"value": ..., "bold", "italic", "strike", "color": "#RRGGBB", "fill": "#RRGGBB", "align"} - use formatting sparingly, to mark a key row or a cell that needs attention.

Example

{
  "type": "table",
  "data": {
    "style": {
      "theme": "clean",
      "banded": false,
      "borders": "all",
      "compact": false,
      "fontSize": 0,
      "font": "default"
    },
    "fields": [
      {
        "name": "Q4 Launch Planning",
        "type": "text",
        "width": 0,
        "options": [
          {
            "label": "string",
            "color": "blue"
          }
        ],
        "summary": "sum",
        "rowHeaders": false,
        "imageSize": "s",
        "voteLimit": 0
      }
    ],
    "rows": [
      "string"
    ]
  }
}

Add one record

POST /boards/{boardId}/items/{itemId}/records adds one of these to an item already on a board and leaves the rest of it as it is. Send the same key again to update that record instead of adding another.

Record fields

record
cellsobjectrequired

Column name to value. Columns the table does not have are left out.

keystring

Your own id for this record, like an issue key. Sending the same key again updates and moves that record instead of adding another.

{
  "record": {
    "cells": {},
    "key": "string"
  }
}
Was this page helpful?

Sign in to MockFlow

The same account you use in the app and on the API.

Forgot your password?
or
Continue with GoogleContinue with MicrosoftContinue with Apple