Endpoints

Referência: Kanban

Quadros, cartões, comentários, checklist, anexos e o feed de mudanças.

Nesta página

Todos os exemplos de resposta foram gerados chamando a API de verdade. Os caminhos são relativos à base URL e toda chamada leva Authorization: Bearer nck_….

Base URLhttps://app.nextchat.nextsistem.dev.br/api/integrations/v1

Escritas (POST) levam o cabeçalho Idempotency-Key. Edições e movimentos levam a version lida do cartão: se ele mudou desde então, a resposta é 409. Campos e filtros: Campos e filtros do Kanban.

Listar quadros

GET /kanban/boards Permissão read

Permissão: read. Somente quadros permitidos; cartões privados e de canais privados são excluídos.

Filtros (query string)

Parâmetro	Tipo	Descrição
`archived`	texto	1 = inclui quadros arquivados. · `0`, `1`

Exemplo de chamada

GET/kanban/boardsbash

curl -X GET "$NEXTCHAT_API/kanban/boards" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Resposta 200 · Sucesso

Resposta 200json

[
  {
    "archived": false,
    "card_count": 0,
    "color": "#4f6bed",
    "description": "",
    "id": "b7a43f45-ee55-48b3-b378-d4cd5a2436c5",
    "name": "Pedidos",
    "overdue_count": 0,
    "stages": [
      {
        "board_id": "b7a43f45-ee55-48b3-b378-d4cd5a2436c5",
        "card_count": 0,
        "color": "#94a3b8",
        "id": "b991630c-c768-47ca-957a-27fb4dc704cd",
        "kind": "open",
        "name": "A fazer",
        "overdue_count": 0,
        "position": 0
      },
      {
        "board_id": "b7a43f45-ee55-48b3-b378-d4cd5a2436c5",
        "card_count": 0,
        "color": "#4f6bed",
        "id": "b7ec2778-c6d0-4508-bec8-5b041bab336f",
        "kind": "open",
        "name": "Em andamento",
        "overdue_count": 0,
        "position": 1
      },
      {
        "board_id": "b7a43f45-ee55-48b3-b378-d4cd5a2436c5",
        "card_count": 0,
        "color": "#16a34a",
        "id": "d2e41073-0cb4-4fc1-ae40-873475f200ad",
        "kind": "won",
        "name": "Concluído",
        "overdue_count": 0,
        "position": 2
      }
    ]
  }
]

Erros possíveis: 400, 401, 403, 404, 409, 413, 428, 429, 503. O que cada um significa e o formato: Limites e erros.

Consultar quadro

GET /kanban/boards/{id} Permissão read

Permissão: read. Somente quadros permitidos; cartões privados e de canais privados são excluídos.

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID).

Exemplo de chamada

GET/kanban/boards/{id}bash

curl -X GET "$NEXTCHAT_API/kanban/boards/{id}" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Resposta 200 · Sucesso

Resposta 200json

{
  "archived": false,
  "card_count": 0,
  "color": "#4f6bed",
  "description": "",
  "id": "b7a43f45-ee55-48b3-b378-d4cd5a2436c5",
  "name": "Pedidos",
  "overdue_count": 0,
  "stages": [
    {
      "board_id": "b7a43f45-ee55-48b3-b378-d4cd5a2436c5",
      "card_count": 0,
      "color": "#94a3b8",
      "id": "b991630c-c768-47ca-957a-27fb4dc704cd",
      "kind": "open",
      "name": "A fazer",
      "overdue_count": 0,
      "position": 0
    },
    {
      "board_id": "b7a43f45-ee55-48b3-b378-d4cd5a2436c5",
      "card_count": 0,
      "color": "#4f6bed",
      "id": "b7ec2778-c6d0-4508-bec8-5b041bab336f",
      "kind": "open",
      "name": "Em andamento",
      "overdue_count": 0,
      "position": 1
    },
    {
      "board_id": "b7a43f45-ee55-48b3-b378-d4cd5a2436c5",
      "card_count": 0,
      "color": "#16a34a",
      "id": "d2e41073-0cb4-4fc1-ae40-873475f200ad",
      "kind": "won",
      "name": "Concluído",
      "overdue_count": 0,
      "position": 2
    }
  ]
}

Erros possíveis: 400, 401, 403, 404, 409, 413, 428, 429, 503. O que cada um significa e o formato: Limites e erros.

Buscar cartões

GET /kanban/cards Permissão read

Permissão: read. Somente quadros permitidos; cartões privados e de canais privados são excluídos.

Filtros (query string)

Parâmetro	Tipo	Descrição
`board_id`	UUID	Só cartões deste quadro.
`limit`	número	Itens por página. · mínimo 1; máximo 100; padrão `30`
`cursor`	texto	next_cursor da página anterior.
`q`	texto	Busca no título e na descrição. · até 100 caracteres
`priority`	texto	Só desta prioridade. · `low`, `medium`, `high`, `urgent`
`label`	UUID	Só com esta etiqueta (UUID).
`due`	texto	Prazo: qualquer, hoje, nesta semana, vencido ou sem prazo. · `any`, `today`, `week`, `overdue`, `none`
`tz`	texto	Fuso para "hoje" e "semana". · padrão `America/Sao_Paulo`
`status`	texto	all, open (abertos) ou closed (concluídos). · `all`, `open`, `closed`
`archived`	texto	1 = só arquivados. · `0`, `1`
`sort`	texto	Ordem da lista. · `updated`, `created`, `due`; padrão `updated`
`stage_id`	texto	Só cartões desta etapa.
`assignee`	texto	UUID, none ou me.
`updated_since`	texto	Alterados a partir de (RFC 3339).
`view`	texto	compact corta a descrição em 200 caracteres e tira checklist e campos. · `compact`

Exemplo de chamada

GET/kanban/cardsbash

curl -X GET "$NEXTCHAT_API/kanban/cards" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Resposta 200 · Sucesso

Resposta 200json

{
  "items": [
    {
      "archived": false,
      "assignee_id": null,
      "assignee_name": "",
      "attachment_count": 0,
      "board_id": "b7a43f45-ee55-48b3-b378-d4cd5a2436c5",
      "board_name": "Pedidos",
      "checklist_done": 0,
      "checklist_total": 3,
      "closed_at": null,
      "created_at": "2026-10-22T22:26:57.093111-03:00",
      "created_by": "5c82d935-9e12-41d5-b3ff-5ea839823470",
      "created_by_name": "Amanda Costa",
      "custom_values": {},
      "description": "2 pizzas grandes",
      "due_at": null,
      "id": "e0e5f587-9f8f-4e38-bd88-abd6119896b3",
      "labels": [],
      "open_blockers": 0,
      "parent_id": null,
      "position": 1,
      "priority": "high",
      "stage_id": "b991630c-c768-47ca-957a-27fb4dc704cd",
      "stage_kind": "open",
      "stage_name": "A fazer",
      "subtask_done": 0,
      "subtask_total": 0,
      "title": "Pedido da Maria",
      "updated_at": "2026-10-22T22:26:57.093111-03:00",
      "updated_by": "5c82d935-9e12-41d5-b3ff-5ea839823470",
      "updated_by_name": "API · ERP da loja",
      "url": "https://app.nextchat.nextsistem.dev.br/kanban?card=e0e5f587-9f8f-4e38-bd88-abd6119896b3",
      "version": 1
    }
  ],
  "next_cursor": null
}

Erros possíveis: 400, 401, 403, 404, 409, 413, 428, 429, 503. O que cada um significa e o formato: Limites e erros.

Consultar cartão e checklist

GET /kanban/cards/{id} Permissão read

Permissão: read. Somente quadros permitidos; cartões privados e de canais privados são excluídos.

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID).

Exemplo de chamada

GET/kanban/cards/{id}bash

curl -X GET "$NEXTCHAT_API/kanban/cards/{id}" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Resposta 200 · Sucesso

Resposta 200json

{
  "archived": false,
  "assignee_id": null,
  "assignee_name": "",
  "attachment_count": 0,
  "attachments": [],
  "board_id": "b7a43f45-ee55-48b3-b378-d4cd5a2436c5",
  "board_name": "Pedidos",
  "checklist": [
    {
      "assignee_id": null,
      "assignee_name": "",
      "done": false,
      "done_at": null,
      "id": "cad910a6-6c2c-40a3-8cfa-24ccdbf0f963",
      "position": 0,
      "text": "Separar ingredientes"
    },
    {
      "assignee_id": null,
      "assignee_name": "",
      "done": false,
      "done_at": null,
      "id": "041f9906-756e-40d5-904f-eed507fb78f0",
      "position": 1,
      "text": "Assar"
    },
    {
      "assignee_id": null,
      "assignee_name": "",
      "done": false,
      "done_at": null,
      "id": "62ddd58c-1f24-4327-8189-b7cada4717a9",
      "position": 2,
      "text": "Entregar"
    }
  ],
  "checklist_done": 0,
  "checklist_total": 3,
  "closed_at": null,
  "created_at": "2026-10-22T22:26:57.093111-03:00",
  "created_by": "5c82d935-9e12-41d5-b3ff-5ea839823470",
  "created_by_name": "Amanda Costa",
  "custom_values": {},
  "description": "2 pizzas grandes",
  "due_at": null,
  "id": "e0e5f587-9f8f-4e38-bd88-abd6119896b3",
  "labels": [],
  "open_blockers": 0,
  "parent_id": null,
  "position": 1,
  "priority": "high",
  "stage_id": "b991630c-c768-47ca-957a-27fb4dc704cd",
  "stage_kind": "open",
  "stage_name": "A fazer",
  "subtask_done": 0,
  "subtask_total": 0,
  "title": "Pedido da Maria",
  "updated_at": "2026-10-22T22:26:57.093111-03:00",
  "updated_by": "5c82d935-9e12-41d5-b3ff-5ea839823470",
  "updated_by_name": "API · ERP da loja",
  "url": "https://app.nextchat.nextsistem.dev.br/kanban?card=e0e5f587-9f8f-4e38-bd88-abd6119896b3",
  "version": 1
}

Erros possíveis: 400, 401, 403, 404, 409, 413, 428, 429, 503. O que cada um significa e o formato: Limites e erros.

Editar cartão

PATCH /kanban/cards/{id} Permissão update

Permissão: update. Somente quadros permitidos; cartões privados e de canais privados são excluídos.

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID).

Corpo (JSON)

Campo	Tipo	Descrição
`title`	texto	Título do cartão (1 a 200 caracteres). · até 200 caracteres
`description`	texto	Máximo de 10.000 bytes em UTF-8. · até 10.000 bytes UTF-8
`priority`	texto	Prioridade. · `low`, `medium`, `high`, `urgent`
`due_at`	data	Prazo (RFC 3339); null tira o prazo. · aceita null
`label_ids`	lista	Etiquetas (GET /kanban/labels); a lista substitui as atuais. · até 20 itens; lista de UUIDs
`version`	número	Versão que você leu (campo version do cartão). Se o cartão mudou desde então, a resposta é 409. · mínimo 1
`assignee_id`	UUID	Responsável (GET /kanban/boards/{id}/members); null tira. · aceita null
`custom_values`	objeto	Campos personalizados: {"<field_id>": valor} (GET /kanban/boards/{id}/fields).

Exemplo de chamada

PATCH/kanban/cards/{id}bash

curl -X PATCH "$NEXTCHAT_API/kanban/cards/{id}" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"Pedido da Maria (2 pizzas)","version":1}'

Resposta 200 · Sucesso

Resposta 200json

{
  "archived": false,
  "assignee_id": null,
  "assignee_name": "",
  "attachment_count": 0,
  "board_id": "b7a43f45-ee55-48b3-b378-d4cd5a2436c5",
  "board_name": "Pedidos",
  "checklist_done": 0,
  "checklist_total": 3,
  "closed_at": null,
  "created_at": "2026-10-22T22:26:57.093111-03:00",
  "created_by": "5c82d935-9e12-41d5-b3ff-5ea839823470",
  "created_by_name": "Amanda Costa",
  "custom_values": {},
  "description": "2 pizzas grandes",
  "due_at": null,
  "id": "e0e5f587-9f8f-4e38-bd88-abd6119896b3",
  "labels": [],
  "open_blockers": 0,
  "parent_id": null,
  "position": 1,
  "priority": "high",
  "stage_id": "b991630c-c768-47ca-957a-27fb4dc704cd",
  "stage_kind": "open",
  "stage_name": "A fazer",
  "subtask_done": 0,
  "subtask_total": 0,
  "title": "Pedido da Maria (2 pizzas)",
  "updated_at": "2026-10-22T22:26:57.158238-03:00",
  "updated_by": "5c82d935-9e12-41d5-b3ff-5ea839823470",
  "updated_by_name": "API · ERP da loja",
  "url": "https://app.nextchat.nextsistem.dev.br/kanban?card=e0e5f587-9f8f-4e38-bd88-abd6119896b3",
  "version": 2
}

Erros possíveis: 400, 401, 403, 404, 409, 413, 428, 429, 503. O que cada um significa e o formato: Limites e erros.

Criar cartão

POST /kanban/boards/{id}/cards Permissão create

Permissão: create. Somente quadros permitidos; cartões privados e de canais privados são excluídos.

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID).

Corpo (JSON)

Campo	Tipo	Descrição
`title` obrigatório	texto	Título do cartão (1 a 200 caracteres). · até 200 caracteres
`description`	texto	Máximo de 10.000 bytes em UTF-8. · até 10.000 bytes UTF-8
`stage_id`	UUID	Etapa (GET /kanban/boards/{id}); sem ela, a primeira etapa.
`priority`	texto	Prioridade. · `low`, `medium`, `high`, `urgent`
`due_at`	data	Prazo (RFC 3339); null tira o prazo. · aceita null
`label_ids`	lista	Etiquetas (GET /kanban/labels); a lista substitui as atuais. · até 20 itens; lista de UUIDs
`checklist`	lista	Itens da checklist, em ordem. · até 100 itens; lista de string
`assignee_id`	UUID	Responsável (GET /kanban/boards/{id}/members); null tira.
`template_id`	UUID	Modelo de cartão do quadro (GET /kanban/boards/{id}/templates).
`custom_values`	objeto	Campos personalizados: {"<field_id>": valor} (GET /kanban/boards/{id}/fields).

Exemplo de chamada

POST/kanban/boards/{id}/cardsbash

curl -X POST "$NEXTCHAT_API/kanban/boards/{id}/cards" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"checklist":["Separar ingredientes","Assar","Entregar"],"description":"2 pizzas grandes","priority":"high","title":"Pedido da Maria"}'

Resposta 201 · Criado

Resposta 201json

{
  "archived": false,
  "assignee_id": null,
  "assignee_name": "",
  "attachment_count": 0,
  "attachments": [],
  "board_id": "b7a43f45-ee55-48b3-b378-d4cd5a2436c5",
  "board_name": "Pedidos",
  "checklist": [
    {
      "assignee_id": null,
      "assignee_name": "",
      "done": false,
      "done_at": null,
      "id": "cad910a6-6c2c-40a3-8cfa-24ccdbf0f963",
      "position": 0,
      "text": "Separar ingredientes"
    },
    {
      "assignee_id": null,
      "assignee_name": "",
      "done": false,
      "done_at": null,
      "id": "041f9906-756e-40d5-904f-eed507fb78f0",
      "position": 1,
      "text": "Assar"
    },
    {
      "assignee_id": null,
      "assignee_name": "",
      "done": false,
      "done_at": null,
      "id": "62ddd58c-1f24-4327-8189-b7cada4717a9",
      "position": 2,
      "text": "Entregar"
    }
  ],
  "checklist_done": 0,
  "checklist_total": 3,
  "closed_at": null,
  "created_at": "2026-10-22T22:26:57.093111-03:00",
  "created_by": "5c82d935-9e12-41d5-b3ff-5ea839823470",
  "created_by_name": "Amanda Costa",
  "custom_values": {},
  "description": "2 pizzas grandes",
  "due_at": null,
  "id": "e0e5f587-9f8f-4e38-bd88-abd6119896b3",
  "labels": [],
  "open_blockers": 0,
  "parent_id": null,
  "position": 1,
  "priority": "high",
  "stage_id": "b991630c-c768-47ca-957a-27fb4dc704cd",
  "stage_kind": "open",
  "stage_name": "A fazer",
  "subtask_done": 0,
  "subtask_total": 0,
  "title": "Pedido da Maria",
  "updated_at": "2026-10-22T22:26:57.093111-03:00",
  "updated_by": "5c82d935-9e12-41d5-b3ff-5ea839823470",
  "updated_by_name": "API · ERP da loja",
  "url": "https://app.nextchat.nextsistem.dev.br/kanban?card=e0e5f587-9f8f-4e38-bd88-abd6119896b3",
  "version": 1
}

Erros possíveis: 400, 401, 403, 404, 409, 413, 428, 429, 503. O que cada um significa e o formato: Limites e erros.

Mover cartão

POST /kanban/cards/{id}/move Permissão move

Permissão: move. Somente quadros permitidos; cartões privados e de canais privados são excluídos.

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID).

Corpo (JSON)

Campo	Tipo	Descrição
`stage_id` obrigatório	UUID	Etapa de destino.
`version`	número	Versão que você leu (campo version do cartão). Se o cartão mudou desde então, a resposta é 409. · mínimo 1
`before_id`	UUID	Coloca antes deste cartão.
`after_id`	UUID	Coloca depois deste cartão.
`place`	texto	start (topo) ou end (fim) da etapa. · `start`, `end`

Exemplo de chamada

POST/kanban/cards/{id}/movebash

curl -X POST "$NEXTCHAT_API/kanban/cards/{id}/move" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"stage_id":"b7ec2778-c6d0-4508-bec8-5b041bab336f","version":2}'

Resposta 200 · Sucesso

Resposta 200json

{
  "archived": false,
  "assignee_id": null,
  "assignee_name": "",
  "attachment_count": 0,
  "board_id": "b7a43f45-ee55-48b3-b378-d4cd5a2436c5",
  "board_name": "Pedidos",
  "checklist_done": 0,
  "checklist_total": 3,
  "closed_at": null,
  "created_at": "2026-10-22T22:26:57.093111-03:00",
  "created_by": "5c82d935-9e12-41d5-b3ff-5ea839823470",
  "created_by_name": "Amanda Costa",
  "custom_values": {},
  "description": "2 pizzas grandes",
  "due_at": null,
  "id": "e0e5f587-9f8f-4e38-bd88-abd6119896b3",
  "labels": [],
  "open_blockers": 0,
  "parent_id": null,
  "position": 1,
  "priority": "high",
  "stage_id": "b7ec2778-c6d0-4508-bec8-5b041bab336f",
  "stage_kind": "open",
  "stage_name": "Em andamento",
  "subtask_done": 0,
  "subtask_total": 0,
  "title": "Pedido da Maria (2 pizzas)",
  "updated_at": "2026-10-22T22:26:57.173414-03:00",
  "updated_by": "5c82d935-9e12-41d5-b3ff-5ea839823470",
  "updated_by_name": "API · ERP da loja",
  "url": "https://app.nextchat.nextsistem.dev.br/kanban?card=e0e5f587-9f8f-4e38-bd88-abd6119896b3",
  "version": 3
}

Erros possíveis: 400, 401, 403, 404, 409, 413, 428, 429, 503. O que cada um significa e o formato: Limites e erros.

Adicionar comentário

POST /kanban/cards/{id}/comments Permissão comments:write

Permissão: comments:write. Somente quadros permitidos; cartões privados e de canais privados são excluídos.

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID).

Corpo (JSON)

Campo	Tipo	Descrição
`text` obrigatório	texto	Texto do comentário. · até 10.000 caracteres
`notify`	sim/não	Avisa no NextChat quem criou o cartão e o responsável.
`mentions`	lista	Pessoas mencionadas (ids de GET /kanban/boards/{id}/members), avisadas no app. · até 20 itens; lista de UUIDs

Exemplo de chamada

POST/kanban/cards/{id}/commentsbash

curl -X POST "$NEXTCHAT_API/kanban/cards/{id}/comments" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"text":"Cliente pediu sem cebola"}'

Resposta 201 · Criado

Resposta 201json

{
  "created_at": "2026-10-22T22:26:57.188824-03:00",
  "id": 4,
  "kind": "comment"
}

Erros possíveis: 400, 401, 403, 404, 409, 413, 428, 429, 503. O que cada um significa e o formato: Limites e erros.

Ler comentários do cartão

GET /kanban/cards/{id}/comments Permissão read

Permissão: read. Somente quadros permitidos; cartões privados e de canais privados são excluídos.

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID).

Filtros (query string)

Parâmetro	Tipo	Descrição
`since`	texto	Só a partir deste instante (RFC 3339).
`cursor`	texto	id do último comentário lido.
`limit`	número	Até 100.

Exemplo de chamada

GET/kanban/cards/{id}/commentsbash

curl -X GET "$NEXTCHAT_API/kanban/cards/{id}/comments" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Resposta 200 · Sucesso

Resposta 200json

{
  "items": [
    {
      "author": {
        "id": null,
        "integration_id": "e71d738f-cfc3-410b-ae43-d02ef5cbf308",
        "name": "API · ERP da loja"
      },
      "created_at": "2026-10-22T22:26:57.188824-03:00",
      "edited_at": null,
      "id": 4,
      "mentions": [],
      "origin": "integration",
      "own": true,
      "text": "Cliente pediu sem cebola"
    }
  ],
  "next_cursor": null
}

Erros possíveis: 401, 403, 404. O que cada um significa e o formato: Limites e erros.

Adicionar checklist

POST /kanban/cards/{id}/checklist Permissão checklist:write

Permissão: checklist:write. Somente quadros permitidos; cartões privados e de canais privados são excluídos.

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID).

Corpo (JSON)

Campo	Tipo	Descrição
`text`	texto	Um item. Para vários de uma vez, use items. · até 300 caracteres
`items`	lista	Vários itens de uma vez, no lugar de text. · até 100 itens; lista de string

Exemplo de chamada

POST/kanban/cards/{id}/checklistbash

curl -X POST "$NEXTCHAT_API/kanban/cards/{id}/checklist" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"text":"Conferir troco"}'

Resposta 201 · Criado

Resposta 201json

{
  "assignee_id": null,
  "assignee_name": "",
  "done": false,
  "done_at": null,
  "id": "dbfa22ee-89c4-4ab9-82ec-f1557fd78e54",
  "position": 3,
  "text": "Conferir troco"
}

Erros possíveis: 400, 401, 403, 404, 409, 413, 428, 429, 503. O que cada um significa e o formato: Limites e erros.

Editar checklist

PATCH /kanban/checklist/{id} Permissão checklist:write

Permissão: checklist:write. Somente quadros permitidos; cartões privados e de canais privados são excluídos.

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID).

Corpo (JSON)

Campo	Tipo	Descrição
`text`	texto	Texto do item. · até 300 caracteres
`done`	sim/não	Marca (true) ou desmarca o item.
`position`	número	Nova posição na lista.

Exemplo de chamada

PATCH/kanban/checklist/{id}bash

curl -X PATCH "$NEXTCHAT_API/kanban/checklist/{id}" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"done":true}'

Resposta 200 · Sucesso

Resposta 200json

{
  "assignee_id": null,
  "assignee_name": "",
  "done": true,
  "done_at": "2026-10-22T22:26:57.218286-03:00",
  "id": "dbfa22ee-89c4-4ab9-82ec-f1557fd78e54",
  "position": 3,
  "text": "Conferir troco"
}

Erros possíveis: 400, 401, 403, 404, 409, 413, 428, 429, 503. O que cada um significa e o formato: Limites e erros.

Apagar item da checklist

DELETE /kanban/checklist/{id} Permissão checklist:write

Permissão: checklist:write. Somente quadros permitidos; cartões privados e de canais privados são excluídos.

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID).

Exemplo de chamada

DELETE/kanban/checklist/{id}bash

curl -X DELETE "$NEXTCHAT_API/kanban/checklist/{id}" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Resposta 204 · Sucesso, sem corpo de resposta

Sem corpo de resposta.

Erros possíveis: 401, 403, 404. O que cada um significa e o formato: Limites e erros.

Listar etiquetas

GET /kanban/labels Permissão read

Permissão: read. Somente quadros permitidos; cartões privados e de canais privados são excluídos.

Exemplo de chamada

GET/kanban/labelsbash

curl -X GET "$NEXTCHAT_API/kanban/labels" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Resposta 200 · Sucesso

Resposta 200json

[
  {
    "color": "#fde68a",
    "id": "1df47ee4-7fd6-404a-b016-aec4c8d7f274",
    "name": "Cliente VIP"
  }
]

Erros possíveis: 401, 403, 404. O que cada um significa e o formato: Limites e erros.

Quem pode ser responsável no quadro

GET /kanban/boards/{id}/members Permissão read

Permissão: read. Somente quadros permitidos; cartões privados e de canais privados são excluídos.

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID).

Exemplo de chamada

GET/kanban/boards/{id}/membersbash

curl -X GET "$NEXTCHAT_API/kanban/boards/{id}/members" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Resposta 200 · Sucesso

Resposta 200json

[
  {
    "id": "c0ee6c5f-9199-4421-a6a5-290a2cfc4391",
    "name": "Ana Souza"
  },
  {
    "id": "5c82d935-9e12-41d5-b3ff-5ea839823470",
    "name": "Amanda Costa"
  }
]

Erros possíveis: 401, 403, 404. O que cada um significa e o formato: Limites e erros.

Campos personalizados do quadro

GET /kanban/boards/{id}/fields Permissão read

Permissão: read. Somente quadros permitidos; cartões privados e de canais privados são excluídos.

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID).

Exemplo de chamada

GET/kanban/boards/{id}/fieldsbash

curl -X GET "$NEXTCHAT_API/kanban/boards/{id}/fields" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Resposta 200 · Sucesso

Resposta 200json

[]

Erros possíveis: 401, 403, 404. O que cada um significa e o formato: Limites e erros.

Modelos de cartão do quadro

GET /kanban/boards/{id}/templates Permissão read

Permissão: read. Somente quadros permitidos; cartões privados e de canais privados são excluídos.

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID).

Exemplo de chamada

GET/kanban/boards/{id}/templatesbash

curl -X GET "$NEXTCHAT_API/kanban/boards/{id}/templates" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Resposta 200 · Sucesso

Resposta 200json

[]

Erros possíveis: 401, 403, 404. O que cada um significa e o formato: Limites e erros.

Feed de mudanças dos cartões

GET /kanban/events Permissão read

Permissão: read. Somente quadros permitidos; cartões privados e de canais privados são excluídos.

Filtros (query string)

Parâmetro	Tipo	Descrição
`cursor`	texto	"latest" para começar de agora; depois, o next_cursor.
`since`	texto	Sem cursor: a partir deste instante (padrão: última hora).
`board_id`	texto	Restringe a um quadro.
`limit`	número	Até 200.

Exemplo de chamada

GET/kanban/eventsbash

curl -X GET "$NEXTCHAT_API/kanban/events" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Resposta 200 · Sucesso

Resposta 200json

{
  "items": [
    {
      "actor_id": "5c82d935-9e12-41d5-b3ff-5ea839823470",
      "actor_name": "API · ERP da loja",
      "board_id": "b7a43f45-ee55-48b3-b378-d4cd5a2436c5",
      "card_id": "e0e5f587-9f8f-4e38-bd88-abd6119896b3",
      "created_at": "2026-10-22T22:26:57.093111-03:00",
      "from_stage_id": null,
      "id": 1,
      "origin": "integration",
      "stage_id": "b7ec2778-c6d0-4508-bec8-5b041bab336f",
      "to_stage_id": "b991630c-c768-47ca-957a-27fb4dc704cd",
      "type": "card_created"
    },
    {
      "actor_id": "5c82d935-9e12-41d5-b3ff-5ea839823470",
      "actor_name": "API · ERP da loja",
      "board_id": "b7a43f45-ee55-48b3-b378-d4cd5a2436c5",
      "card_id": "e0e5f587-9f8f-4e38-bd88-abd6119896b3",
      "created_at": "2026-10-22T22:26:57.158238-03:00",
      "from_stage_id": null,
      "id": 2,
      "origin": "integration",
      "stage_id": "b7ec2778-c6d0-4508-bec8-5b041bab336f",
      "to_stage_id": null,
      "type": "updated"
    },
    {
      "actor_id": "5c82d935-9e12-41d5-b3ff-5ea839823470",
      "actor_name": "API · ERP da loja",
      "board_id": "b7a43f45-ee55-48b3-b378-d4cd5a2436c5",
      "card_id": "e0e5f587-9f8f-4e38-bd88-abd6119896b3",
      "created_at": "2026-10-22T22:26:57.173414-03:00",
      "from_stage_id": "b991630c-c768-47ca-957a-27fb4dc704cd",
      "id": 3,
      "origin": "integration",
      "stage_id": "b7ec2778-c6d0-4508-bec8-5b041bab336f",
      "to_stage_id": "b7ec2778-c6d0-4508-bec8-5b041bab336f",
      "type": "card_moved"
    },
    {
      "actor_id": "5c82d935-9e12-41d5-b3ff-5ea839823470",
      "actor_name": "API · ERP da loja",
      "board_id": "b7a43f45-ee55-48b3-b378-d4cd5a2436c5",
      "card_id": "e0e5f587-9f8f-4e38-bd88-abd6119896b3",
      "created_at": "2026-10-22T22:26:57.188824-03:00",
      "from_stage_id": null,
      "id": 4,
      "origin": "integration",
      "stage_id": "b7ec2778-c6d0-4508-bec8-5b041bab336f",
      "to_stage_id": null,
      "type": "comment_added"
    }
  ],
  "next_cursor": "4"
}

Erros possíveis: 401, 403, 404. O que cada um significa e o formato: Limites e erros.

Editar comentário da própria chave

PATCH /kanban/cards/{id}/comments/{commentId} Permissão comments:write

Permissão: comments:write. Somente quadros permitidos; cartões privados e de canais privados são excluídos.

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID).
`commentId` obrigatório	número	Id do comentário.

Corpo (JSON)

Campo	Tipo	Descrição
`text` obrigatório	texto	até 10.000 caracteres

Exemplo de chamada

PATCH/kanban/cards/{id}/comments/{commentId}bash

curl -X PATCH "$NEXTCHAT_API/kanban/cards/{id}/comments/{commentId}" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"Cliente pediu sem cebola e sem azeitona"}'

Resposta 200 · Sucesso

Resposta 200json

{
  "id": "4",
  "text": "Cliente pediu sem cebola e sem azeitona"
}

Erros possíveis: 401, 403, 404. O que cada um significa e o formato: Limites e erros.

Apagar comentário da própria chave

DELETE /kanban/cards/{id}/comments/{commentId} Permissão comments:write

Permissão: comments:write. Somente quadros permitidos; cartões privados e de canais privados são excluídos.

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID).
`commentId` obrigatório	número	Id do comentário.

Exemplo de chamada

DELETE/kanban/cards/{id}/comments/{commentId}bash

curl -X DELETE "$NEXTCHAT_API/kanban/cards/{id}/comments/{commentId}" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Resposta 204 · Sucesso

Sem corpo de resposta.

Erros possíveis: 401, 403, 404. O que cada um significa e o formato: Limites e erros.

Histórico do cartão (criou, editou, moveu)

GET /kanban/cards/{id}/activity Permissão read

Permissão: read. Somente quadros permitidos; cartões privados e de canais privados são excluídos.

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID).

Exemplo de chamada

GET/kanban/cards/{id}/activitybash

curl -X GET "$NEXTCHAT_API/kanban/cards/{id}/activity" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Resposta 200 · Sucesso

Resposta 200json

[
  {
    "actor_id": "5c82d935-9e12-41d5-b3ff-5ea839823470",
    "actor_name": "API · ERP da loja",
    "created_at": "2026-10-22T22:26:57.173414-03:00",
    "from_stage": "A fazer",
    "id": 3,
    "to_stage": "Em andamento",
    "type": "card_moved"
  },
  {
    "actor_id": "5c82d935-9e12-41d5-b3ff-5ea839823470",
    "actor_name": "API · ERP da loja",
    "changes": {
      "title": true
    },
    "created_at": "2026-10-22T22:26:57.158238-03:00",
    "from_stage": "",
    "id": 2,
    "to_stage": "",
    "type": "updated"
  },
  {
    "actor_id": "5c82d935-9e12-41d5-b3ff-5ea839823470",
    "actor_name": "API · ERP da loja",
    "created_at": "2026-10-22T22:26:57.093111-03:00",
    "from_stage": "",
    "id": 1,
    "to_stage": "A fazer",
    "type": "card_created"
  }
]

Erros possíveis: 401, 403, 404. O que cada um significa e o formato: Limites e erros.

Arquivar cartão (sem exigir versão)

POST /kanban/cards/{id}/archive Permissão update

Permissão: update. Somente quadros permitidos; cartões privados e de canais privados são excluídos.

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID).

Exemplo de chamada

POST/kanban/cards/{id}/archivebash

curl -X POST "$NEXTCHAT_API/kanban/cards/{id}/archive" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Resposta 200 · Sucesso

Resposta 200json

{
  "archived": true,
  "assignee_id": null,
  "assignee_name": "",
  "attachment_count": 0,
  "board_id": "b7a43f45-ee55-48b3-b378-d4cd5a2436c5",
  "board_name": "Pedidos",
  "checklist_done": 0,
  "checklist_total": 3,
  "closed_at": null,
  "created_at": "2026-10-22T22:26:57.093111-03:00",
  "created_by": "5c82d935-9e12-41d5-b3ff-5ea839823470",
  "created_by_name": "Amanda Costa",
  "custom_values": {},
  "description": "2 pizzas grandes",
  "due_at": null,
  "id": "e0e5f587-9f8f-4e38-bd88-abd6119896b3",
  "labels": [],
  "open_blockers": 0,
  "parent_id": null,
  "position": 1,
  "priority": "high",
  "stage_id": "b7ec2778-c6d0-4508-bec8-5b041bab336f",
  "stage_kind": "open",
  "stage_name": "Em andamento",
  "subtask_done": 0,
  "subtask_total": 0,
  "title": "Pedido da Maria (2 pizzas)",
  "updated_at": "2026-10-22T22:26:57.280936-03:00",
  "updated_by": "5c82d935-9e12-41d5-b3ff-5ea839823470",
  "updated_by_name": "API · ERP da loja",
  "url": "https://app.nextchat.nextsistem.dev.br/kanban?card=e0e5f587-9f8f-4e38-bd88-abd6119896b3",
  "version": 4
}

Erros possíveis: 401, 403, 404. O que cada um significa e o formato: Limites e erros.

Restaurar cartão arquivado

POST /kanban/cards/{id}/restore Permissão update

Permissão: update. Somente quadros permitidos; cartões privados e de canais privados são excluídos.

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID).

Exemplo de chamada

POST/kanban/cards/{id}/restorebash

curl -X POST "$NEXTCHAT_API/kanban/cards/{id}/restore" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Resposta 200 · Sucesso

Resposta 200json

{
  "archived": false,
  "assignee_id": null,
  "assignee_name": "",
  "attachment_count": 0,
  "board_id": "b7a43f45-ee55-48b3-b378-d4cd5a2436c5",
  "board_name": "Pedidos",
  "checklist_done": 0,
  "checklist_total": 3,
  "closed_at": null,
  "created_at": "2026-10-22T22:26:57.093111-03:00",
  "created_by": "5c82d935-9e12-41d5-b3ff-5ea839823470",
  "created_by_name": "Amanda Costa",
  "custom_values": {},
  "description": "2 pizzas grandes",
  "due_at": null,
  "id": "e0e5f587-9f8f-4e38-bd88-abd6119896b3",
  "labels": [],
  "open_blockers": 0,
  "parent_id": null,
  "position": 1,
  "priority": "high",
  "stage_id": "b7ec2778-c6d0-4508-bec8-5b041bab336f",
  "stage_kind": "open",
  "stage_name": "Em andamento",
  "subtask_done": 0,
  "subtask_total": 0,
  "title": "Pedido da Maria (2 pizzas)",
  "updated_at": "2026-10-22T22:26:57.285908-03:00",
  "updated_by": "5c82d935-9e12-41d5-b3ff-5ea839823470",
  "updated_by_name": "API · ERP da loja",
  "url": "https://app.nextchat.nextsistem.dev.br/kanban?card=e0e5f587-9f8f-4e38-bd88-abd6119896b3",
  "version": 5
}

Erros possíveis: 401, 403, 404. O que cada um significa e o formato: Limites e erros.

Anexar arquivos (multipart, campo file, até 10)

POST /kanban/cards/{id}/attachments Permissão attachments:write

Permissão: attachments:write. Somente quadros permitidos; cartões privados e de canais privados são excluídos. Corpo multipart/form-data com o campo file (até 10 arquivos).

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID).

Exemplo de chamada

POST/kanban/cards/{id}/attachmentsbash

curl -X POST "$NEXTCHAT_API/kanban/cards/{id}/attachments" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Resposta 201 · Criado

Resposta 201json

[
  {
    "id": "8a1659c4-8a2a-4193-b65f-0a1f67c9f64f",
    "file_name": "comprovante.pdf",
    "mime_type": "application/pdf",
    "kind": "document",
    "size_bytes": 23,
    "added_at": "2026-10-22T22:26:57.252699-03:00",
    "added_by_name": "Amanda Costa",
    "url": "https://arquivos.exemplo/544f5085-b05f-46e1-b98f-daedf1b078dd/0b08dcd0-2c41-400a-9eee-7e9a45521d24?X-Amz-Signature=…"
  }
]

Erros possíveis: 401, 403, 404. O que cada um significa e o formato: Limites e erros.

Listar anexos do cartão (link assinado de 5 minutos)

GET /kanban/cards/{id}/attachments Permissão read

Permissão: read. Somente quadros permitidos; cartões privados e de canais privados são excluídos.

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID).

Exemplo de chamada

GET/kanban/cards/{id}/attachmentsbash

curl -X GET "$NEXTCHAT_API/kanban/cards/{id}/attachments" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Resposta 200 · Sucesso

Resposta 200json

[
  {
    "added_at": "2026-10-22T22:26:57.252699-03:00",
    "added_by_name": "Amanda Costa",
    "file_name": "comprovante.pdf",
    "id": "8a1659c4-8a2a-4193-b65f-0a1f67c9f64f",
    "kind": "document",
    "mime_type": "application/pdf",
    "size_bytes": 23,
    "url": "https://arquivos.exemplo/544f5085-b05f-46e1-b98f-daedf1b078dd/0b08dcd0-2c41-400a-9eee-7e9a45521d24?X-Amz-Signature=…"
  }
]

Erros possíveis: 401, 403, 404. O que cada um significa e o formato: Limites e erros.

Remover anexo

DELETE /kanban/cards/{id}/attachments/{attachmentId} Permissão attachments:delete

Permissão: attachments:delete. Somente quadros permitidos; cartões privados e de canais privados são excluídos.

Parâmetros do caminho

Parâmetro	Tipo	Descrição
`id` obrigatório	UUID	Identificador (UUID).
`attachmentId` obrigatório	UUID	Id do anexo.

Exemplo de chamada

DELETE/kanban/cards/{id}/attachments/{attachmentId}bash

curl -X DELETE "$NEXTCHAT_API/kanban/cards/{id}/attachments/{attachmentId}" \
  -H "Authorization: Bearer $NEXTCHAT_API_KEY"

Resposta 204 · Sucesso, sem corpo de resposta

Sem corpo de resposta.

Erros possíveis: 401, 403, 404. O que cada um significa e o formato: Limites e erros.