API Reference JavaScript

API Reference — JavaScript (@jokelboard/js)

Pure ESM, no build step. Requires Node.js 18+.

import { JokelboardClient } from '@jokelboard/js';

const client = new JokelboardClient({ token: process.env.JOKELBOARD_TOKEN });

Constructor options

Option	Type	Default	Description
token	string	required	API token (jkb_...)
baseUrl	string	https://api.jokelboard.com/api/v1	Override base URL
timeout	number	10000	Request timeout in ms
retryOnRateLimit	boolean	true	Auto-retry on 429
maxRetries	number	3	Max retry attempts

---

Boards

listBoards()

Returns all boards accessible with your token.

const boards = await client.listBoards();

getBoard(boardId)

Returns a single board.

const board = await client.getBoard('board-id');

---

Lists

getLists(boardId)

Returns all lists on a board.

const lists = await client.getLists('board-id');

---

Cards

getCard(boardId, cardId)

const card = await client.getCard('board-id', 'card-id');

createCard(boardId, listId, title, options?)

const card = await client.createCard('board-id', 'list-id', 'Fix login', {
  categoryId: 'P1',
  labels: [{ name: 'bug', color: '#ff5e5e' }],
  description: 'Steps to reproduce...',
});

updateCard(boardId, cardId, data)

Updates card fields including custom field values.

await client.updateCard('board-id', 'card-id', {
  title: 'Updated title',
  fieldValues: { 'discord-id': '123456789' },
});

moveCard(boardId, cardId, targetListId)

await client.moveCard('board-id', 'card-id', 'done-list-id');

deleteCard(boardId, cardId)

await client.deleteCard('board-id', 'card-id');

getCardLink(boardId, cardId)

Returns the shareable URL for a card.

const link = await client.getCardLink('board-id', 'card-id');
console.log(link.url);

---

Comments

addComment(boardId, cardId, text)

await client.addComment('board-id', 'card-id', 'On it.');

---

Vault

getVaultItems(boardId)

const items = await client.getVaultItems('board-id');

---

Tokens

createBoardToken(boardId, options?)

createProfileToken(options?)

createOrgToken(orgId, options?)

---

Plugin API

const plugin = client.plugin('plugin-id', 'plugin-token');
await plugin.getData(boardId, cardId);
await plugin.setData(boardId, cardId, { key: 'value' });