Pular para o conteúdo principal

Boards API

The boards API lets you manage boards and their groups (columns/sections) within projects.

Board Procedures​

board.list​

List all boards in a project.

Type: Query Required scope: read:board

GET /trpc/board.list?input={"projectId":"prj_abc123"}

Response:

{
  "result": {
    "data": [
      {
        "id": "brd_abc123",
        "name": "Main Board",
        "projectId": "prj_abc123",
        "fields": [
          {
            "id": "fld_status",
            "name": "Status",
            "type": "status",
            "options": [
              { "value": "todo", "label": "To Do", "color": "#6b7280" },
              {
                "value": "in_progress",
                "label": "In Progress",
                "color": "#3b82f6"
              },
              { "value": "done", "label": "Done", "color": "#10b981" }
            ]
          },
          {
            "id": "fld_assignee",
            "name": "Assignee",
            "type": "person"
          }
        ],
        "groupCount": 3,
        "itemCount": 47,
        "createdAt": "2026-01-20T09:00:00Z"
      }
    ]
  }
}

board.byId​

Get a specific board by ID, including its field definitions and groups.

Type: Query Required scope: read:board

GET /trpc/board.byId?input={"id":"brd_abc123"}

board.create​

Create a new board in a project.

Type: Mutation Required scope: write:board

POST /trpc/board.create

Input:

{
  "projectId": "prj_abc123",
  "name": "Sprint Board",
  "fields": [
    {
      "name": "Status",
      "type": "status",
      "options": [
        { "value": "todo", "label": "To Do", "color": "#6b7280" },
        { "value": "in_progress", "label": "In Progress", "color": "#3b82f6" },
        { "value": "done", "label": "Done", "color": "#10b981" }
      ]
    },
    {
      "name": "Priority",
      "type": "priority"
    },
    {
      "name": "Assignee",
      "type": "person"
    }
  ],
  "groups": [{ "name": "Backlog" }, { "name": "Sprint 1" }, { "name": "Done" }]
}

board.update​

Update a board's name or settings.

Type: Mutation Required scope: write:board

POST /trpc/board.update

Input:

{
  "id": "brd_abc123",
  "name": "Updated Board Name"
}

board.delete​

Delete a board and all its items.

Type: Mutation Required scope: write:board

POST /trpc/board.delete

Input:

{
  "id": "brd_abc123"
}

Group Procedures​

board.listGroups​

List all groups in a board.

Type: Query

GET /trpc/board.listGroups?input={"boardId":"brd_abc123"}

board.createGroup​

Add a new group to a board.

Type: Mutation

POST /trpc/board.createGroup

Input:

{
  "boardId": "brd_abc123",
  "name": "New Group",
  "color": "#8b5cf6",
  "position": 2
}

board.updateGroup​

Update a group's name, color, or position.

Type: Mutation

POST /trpc/board.updateGroup

Input:

{
  "id": "grp_abc123",
  "name": "Renamed Group",
  "color": "#f59e0b"
}

board.deleteGroup​

Delete a group. Items in the group can be moved to another group or deleted.

Type: Mutation

POST /trpc/board.deleteGroup

Input:

{
  "id": "grp_abc123",
  "moveItemsTo": "grp_def456"
}