Bảng dữ liệu

client.boards là kho dữ liệu cốt lõi cho CRM pipelines — leads, deals, tasks, hoặc bất kỳ dữ liệu có cấu trúc nào. Mỗi board có các trường tùy chỉnh và items. Board cũng có thể liên kết với Knowledge Hub để tìm kiếm bằng AI.

Để xem hướng dẫn chi tiết, tham khảo DataBoards trong hướng dẫn SDK.

---

Schema

Board

Trường	Kiểu	Mô tả
object_name	string?	Định danh loại đối tượng
id	string	ID duy nhất của board
organization_id	string	Tổ chức sở hữu board này
name	string	Tên hiển thị của board
description	string?	Mô tả tùy chọn
workflow_id	string?	ID workflow liên kết
hidden	boolean?	Board có bị ẩn hay không
team_ids	string[]?	Nhóm có quyền truy cập
created_at	string	ISO 8601 thời gian tạo
updated_at	string	ISO 8601 thời gian cập nhật

BoardField

Trường	Kiểu	Mô tả
_id	string	ID duy nhất của trường
name	string	Tên hiển thị của trường
type	string	Kiểu trường (text, number, date, select, v.v.)
options	object[]?	Cấu hình theo kiểu
required	boolean?	Trường có bắt buộc không

CreateBoardInput

Trường	Kiểu	Bắt buộc	Mô tả
name	string	✓	Tên board
description	string		Mô tả tùy chọn
type	string		Loại board
fields	object[]		Định nghĩa trường ban đầu
team_ids	string[]		ID nhóm có quyền truy cập
show_id	boolean		Hiển thị cột ID

---

Phương thức

CRUD Board

Phương thức	TypeScript	Python	Mô tả
Danh sách board	list	list	Danh sách tất cả board
Lấy board	get	get	Lấy board theo ID
Tạo board	create	create	Tạo board mới
Cập nhật board	update	update	Cập nhật tên/mô tả board
Xóa board	delete	delete	Xóa board
Sắp xếp lại board	reorder	reorder	Thay đổi thứ tự hiển thị

Nhập / Xuất

Phương thức	TypeScript	Python	Mô tả
Xuất CSV	exportCsv	export_csv	Xuất tất cả items dưới dạng CSV
Nhập CSV	importCsv	import_csv	Nhập items từ file CSV
Nhập Excel	importExcel	import_excel	Nhập items từ file Excel
Lấy tiến độ import	getImportProgress	get_import_progress	Kiểm tra trạng thái import đang chạy

Trường

Phương thức	TypeScript	Python	Mô tả
Tạo trường	createField	create_field	Thêm cột vào board
Cập nhật trường	updateField	update_field	Sửa cấu hình trường
Xóa trường	deleteField	delete_field	Xóa trường
Sắp xếp lại trường	reorderFields	reorder_fields	Thay đổi thứ tự cột
Cập nhật hàng loạt trường	bulkUpdateFields	bulk_update_fields	Cập nhật nhiều trường cùng lúc

Item

Phương thức	TypeScript	Python	Mô tả
Danh sách item	listItems	list_items	Danh sách items có phân trang
Lấy item	getItem	get_item	Lấy một item
Tạo item	createItem	create_item	Thêm item vào board
Cập nhật item	updateItem	update_item	Cập nhật giá trị trường của item
Xóa item	deleteItem	delete_item	Xóa item
Xóa hàng loạt	bulkDeleteItems	bulk_delete_items	Xóa nhiều items theo ID
Tìm kiếm	search	search	Tìm kiếm toàn văn trong board
Liên kết item	linkItems	link_items	Liên kết item với item board khác
Hủy liên kết item	unlinkItems	unlink_items	Xóa liên kết giữa các items

Segments

Phương thức	TypeScript	Python	Mô tả
Danh sách segment	listSegments	list_segments	Danh sách các view filter đã lưu
Tạo segment	createSegment	create_segment	Lưu filter thành segment
Cập nhật segment	updateSegment	update_segment	Cập nhật filter của segment
Xóa segment	deleteSegment	delete_segment	Xóa segment

---

list / list

TypeScript

const { data: boards } = await client.boards.list({ limit: 20 });
for (const board of boards) {
  console.log(board.id, board.name);
}

Python

result = client.boards.list(limit=20)
for board in result.get("data", []):
    print(board["id"], board["name"])

---

create / create

TypeScript

const board = await client.boards.create({
  name: "Enterprise Leads",
  description: "Leads from the enterprise segment",
  fields: [
    { name: "Company", type: "text" },
    { name: "Deal Size", type: "number" },
    { name: "Stage", type: "select", options: { choices: ["Prospect", "Qualified", "Closed"] } },
  ],
});

Python

board = client.boards.create(
    "Enterprise Leads",
    description="Leads from the enterprise segment",
    fields=[
        {"name": "Company", "type": "text"},
        {"name": "Deal Size", "type": "number"},
        {"name": "Stage", "type": "select", "options": {"choices": ["Prospect", "Qualified", "Closed"]}},
    ],
)

---

createItem / create_item

Truyền một mảng fields với mỗi phần tử có board_field_id (_id của BoardField) và value tương ứng.

TypeScript

const item = await client.boards.createItem("board_id", {
  fields: [
    { board_field_id: "field_id_company", value: "Acme Corp" },
    { board_field_id: "field_id_deal_size", value: 50000 },
    { board_field_id: "field_id_stage", value: "Qualified" },
  ],
});

Python

item = client.boards.create_item("board_id", {
    "fields": [
        {"board_field_id": "field_id_company", "value": "Acme Corp"},
        {"board_field_id": "field_id_deal_size", "value": 50000},
        {"board_field_id": "field_id_stage", "value": "Qualified"},
    ],
})

---

listItems / list_items

TypeScript

const page = await client.boards.listItems("board_id", { limit: 50, skip: 0 });
console.log(`${page.data.length} of ${page.total} items`);

Python

page = client.boards.list_items("board_id", limit=50, skip=0)
print(f"{len(page['data'])} of {page['total']} items")

---

search

Tìm kiếm toàn văn trong các items của board.

TypeScript

const results = await client.boards.search("board_id", {
  q: "Acme",
  limit: 20,
  offset: 0,
});

Python

results = client.boards.search("board_id", q="Acme", limit=20, offset=0)

---

importCsv / import_csv

TypeScript

const formData = new FormData();
formData.append("file", csvBlob, "leads.csv");
const result = await client.boards.importCsv("board_id", formData);
console.log(`Imported: ${result.imported}, Errors: ${result.errors}`);

Python

with open("leads.csv", "rb") as f:
    result = client.boards.import_csv("board_id", files={"file": f})
print(result)

---

createField / create_field

TypeScript

const field = await client.boards.createField("board_id", {
  name: "Priority",
  type: "select",
  options: { choices: ["Low", "Medium", "High"] },
});

Python

field = client.boards.create_field("board_id", {
    "name": "Priority",
    "type": "select",
    "options": {"choices": ["Low", "Medium", "High"]},
})