Skip to content
MelonforceAPI docs

Overview

A REST API, with JSON over HTTPS, that lets your own code read and change your workspace's boards.

Every call goes to one address:

Address
https://api.melonforce.com/v1

What people can do with boards in the app, your code can do with an API key.

What it covers

  • Boards: list, read, create, change, delete and restore them.
  • Columns: add, change, reorder, copy, delete and restore them, and change their type.
  • Views: create, change, reorder and delete saved views.
  • Groups: list, create, rename, recolor, reorder, delete and restore them. A group is a named, colored section of a board that holds items. Every item is in one group, and a new board starts with one group, named after the board.
  • Items: create, read, update, move, archive, delete and restore them. Put a new item at the top or end of a group, and move an item to another group, or to the top or end of its own. Create and update many at once in a batch. Query a board's items with a filter, a sort and paging, or run a saved view.
  • Notes: read and save an item's notes, in Markdown.
  • Updates: read an item's updates feed, and post to it. A key can edit and delete its own posts.
  • Changes: follow a board's changes, and read an item's change log.
  • Members: list the workspace's members, so you can set a person column.

Your first call

You need an API key. An owner or admin of your workspace makes one in the app; Authentication shows how. Keep the key in an environment variable, then list your boards:

List your boards
curl https://api.melonforce.com/v1/boards \
  -H "Authorization: Bearer $MELONFORCE_API_KEY"

The answer lists the workspace's boards, oldest first:

Answer
{
  "boards": [
    {
      "id": "brd_8k2m4q7x1v9c3n5b6z0wp",
      "name": "Moves",
      "itemWord": "move",
      "createdAt": "2026-11-18T09:30:00.000Z",
      "updatedAt": "2026-11-18T09:30:00.000Z"
    }
  ]
}

Every answer is JSON. An error has the same shape on every route: a code, and for some codes details.

An error
{ "error": { "code": "NOT_FOUND" } }

Treat a code you don't know by its HTTP status. Errors lists every code.

Versions

The version is in the path: /v1.

Adding a route, an optional field, an error code, a column type or a kind of change doesn't change the version. Ignore fields, column types and kinds of change you don't know, and treat an error code you don't know by its HTTP status.

A change that would break your code means a new version, /v2. /v1 keeps running for a period we announce ahead.

What a key can't do

A key can't manage members, invitations, API keys or Gmail. Those stay with people signed in to the app, and their routes aren't in these docs. A key that calls one gets 403 FORBIDDEN. Authentication has the details.

Next steps

Guides:

  • Authentication: make a key, send it, keep it safe, and know when it stops working.
  • Errors: the error body, and every code with its status and meaning.
  • Rate limits: how many requests your keys may make, and how to retry.
  • Requests: JSON, IDs, body limits, Idempotency-Key, paging and versions.
  • Column values: column IDs, and the value of each column type.
  • Querying items: filter, sort and search a board's items, read them group by group or with a Group by, or run a saved view.
  • Batch writes: create and update up to 100 items in one request, all or none.
  • Changes feed: follow a board's changes and keep your own copy current.

Reference, one page per area:

  • Boards: list, read, create, change, delete and restore boards.
  • Columns: add, change, reorder, copy, convert, delete and restore columns.
  • Views: create, change, reorder and delete saved views.
  • Groups: list, create, change, reorder, delete and restore a board's groups.
  • Items: create, read, query, update, move, archive, delete and restore items, and batch writes.
  • Notes: read and save an item's notes.
  • Updates: an item's updates feed, and your key's posts.
  • Changes: a board's changes and an item's change log.
  • Members: the workspace's members, for person columns.

The OpenAPI file describes every route above in OpenAPI 3.1, for Postman, Insomnia or a client generator.