NoteBugsDocs

Referência da API

Quadro

O payload único de um espaço de trabalho.

É a rota que a interface chama a cada abertura. Quem integra por fora normalmente prefere as rotas por recurso, que devolvem bem menos, mas esta é a única que traz o quadro inteiro numa requisição só.

GET/api/board
Papel: LeitorEspaço de trabalho

O quadro completo de UM espaço de trabalho, num payload só.

Traz tenants, colunas, projetos, epics, etiquetas, modelos, cards, vínculos e as configurações. Os cards vêm numa lista plana, e não aninhados por coluna: cada card traz o columnId a que pertence.

Parâmetros de query

CampoTipoDescrição
tenantcuidO espaço pedido. Um id que a conta não alcança cai no primeiro espaço dela, e é pelo campo tenantId da resposta que se descobre isso.Ausente: o primeiro espaço da pessoa

Requisição

curl -s "http://localhost:3000/api/board?tenant=cmsp4djx60002p801o7ybpkv7" \
  -H "Authorization: Bearer $TOKEN"

Resposta200

{
  "tenants": [
    { "id": "cmsp4djx60002p801o7ybpkv7", "name": "Pessoal", "color": "amber", "position": 0, "cardCount": 12, "projectCount": 2 }
  ],
  "tenantId": "cmsp4djx60002p801o7ybpkv7",
  "columns": [
    { "id": "cmttg1vdl000tlf01uuqhz8ad", "projectId": null, "name": "A fazer", "accent": "stone", "position": 0, "done": false }
  ],
  "projects": [
    { "id": "cmttg1vjy000zlf015g097nhi", "name": "Integrações", "description": null, "color": "sky", "position": 0 }
  ],
  "epics": [
    { "id": "cmttg1vs50015lf010l6k38uq", "projectId": "cmttg1vjy000zlf015g097nhi", "name": "Onboarding", "description": null, "color": "amber", "status": "ACTIVE", "locked": false, "dueAt": "2026-10-31T23:59:00.000Z", "dueAtZone": "America/Sao_Paulo", "position": 0 }
  ],
  "tags": [{ "id": "cmttg1vnk0011lf01q0eswms5", "name": "api", "color": "mint" }],
  "templates": [],
  "cards": [],
  "relations": [],
  "settings": {
    "allowCrossProjectLinks": false,
    "epicsEnabled": true,
    "columnScope": "TENANT",
    "uploadMode": "ALL"
    // … os demais campos de ApiSettings; ver GET /api/settings
  }
}

Respostas de erro

CódigoQuando acontece
401Sem credencial, ou com uma que não vale mais. Mande o cookie de sessão ou o cabeçalho Authorization: Bearer.
403A conta não alcança o espaço de trabalho do recurso. É 403 e não 404 de propósito: assim a resposta não revela quais espaços existem.

Quem não é membro de nenhum espaço recebe um payload vazio, e não 403: é um estado da conta, não uma falha. Comentários e histórico ficam fora deste payload.