Board API

Overview

The Board API lets you interact with structured data in Copera. Boards contain tables, which contain rows with typed columns. You can list, read, and create records, authenticate rows against password columns, and manage row comments.

The Copera Node.js SDK and CLI fully support all Board operations. Choose your preferred tool below.

Quick Start

REST API
Node.js SDK
CLI

# List all boards
curl -X GET https://api.copera.ai/public/v1/board/list-boards \
  -H "Authorization: Bearer YOUR_API_KEY"

# Get a specific board
curl -X GET https://api.copera.ai/public/v1/board/board/{boardId} \
  -H "Authorization: Bearer YOUR_API_KEY"

# Create a row
curl -X POST https://api.copera.ai/public/v1/board/board/{boardId}/table/{tableId}/row \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "columns": [
      { "columnId": "col_id", "value": "Hello" }
    ]
  }'

npm install @copera.ai/sdk

import { CoperaAI } from '@copera.ai/sdk';

const copera = CoperaAI({ apiKey: 'your-api-key' });

// List all boards
const boards = await copera.board.listBoards();

// Get board details
const board = await copera.board.getBoardDetails({ boardId: 'board-id' });

// List tables in a board
const tables = await copera.board.listBoardTables({ boardId: 'board-id' });

// List rows in a table
const rows = await copera.board.listTableRows({
  boardId: 'board-id',
  tableId: 'table-id'
});

// Create a row
const newRow = await copera.board.createTableRow({
  boardId: 'board-id',
  tableId: 'table-id',
  columns: [{ columnId: 'col-1', value: 'Value' }]
});

// Authenticate a row (custom auth via board tables)
const authRow = await copera.board.authenticateTableRow({
  boardId: 'board-id',
  tableId: 'table-id',
  identifierColumnId: 'email-col',
  identifierColumnValue: 'user@example.com',
  passwordColumnId: 'password-col',
  passwordColumnValue: 'user-password'
});

// List row comments (with pagination)
const comments = await copera.board.listRowComments({
  boardId: 'board-id',
  tableId: 'table-id',
  rowId: 'row-id',
  visibility: 'all'
});

// Create a row comment
await copera.board.createRowComment({
  boardId: 'board-id',
  tableId: 'table-id',
  rowId: 'row-id',
  content: '<p>This needs review</p>',
  visibility: 'internal'
});

@copera.ai/sdk

Full SDK documentation and source code

curl -fsSL https://cli.copera.ai/install.sh | bash

# List all boards
copera boards list
copera boards list --json      # JSON output for scripting

# Get board details
copera boards get <board-id>

# List tables
copera tables list --board <board-id>
copera tables get <table-id>

# List and get rows
copera rows list --board <id> --table <id>
copera rows get <row-id>

# Create a row
copera rows create --data '{"columns":[{"columnId":"col-1","value":"Value"}]}'
echo '{"columns":[...]}' | copera rows create   # from stdin

copera-cli

CLI installation, configuration, and full command reference

Available Operations

Operation	Description
List Boards	Retrieve all boards accessible to your integration
Get Board	Get details of a specific board
List Tables	List all tables in a board
Get Table	Get table schema and column definitions
List Rows	List all rows in a table
Get Row	Retrieve a specific row with column values
Create Row	Create a new row with column values
Authenticate Row	Authenticate against identifier and password columns
List Row Comments	List comments on a row with pagination and visibility filters
Create Row Comment	Add a comment to a row with HTML content

Next Steps

How a Board Works — Understand the board data model, permissions, and automations
List Boards — API endpoint reference

General

Board

Docs

Drive

Channel

Overview

Quick Start

@copera.ai/sdk

copera-cli

Available Operations

Next Steps

General

Board

Docs

Drive

Channel

​Overview

​Quick Start

@copera.ai/sdk

copera-cli

​Available Operations

​Next Steps

Overview

Quick Start

Available Operations

Next Steps