JavaScript¶

SeaTable provides a JavaScript API that works in two contexts: inside SeaTable as a script, or externally via Node.js or a frontend application. The core methods (tables, views, columns, rows, links, SQL) are the same in both contexts. Features that are only available in one context are clearly marked on the respective pages.

Script vs. External Client¶

Installation¶

npm install seatable-api

Not needed for scripts inside SeaTable.

Authentication¶

External programs need an API token for authentication. API tokens can be generated in the SeaTable web interface. Scripts inside SeaTable require no authentication.

import { Base } from "seatable-api";

const base = new Base({
  server: "https://cloud.seatable.io",
  APIToken: "your-api-token",
});
await base.auth();

Async Operations¶

External API calls are asynchronous and return promises. Use await to wait for the result.

In scripting context, most methods are synchronous. The exceptions are query() and getLinkedRecords(), which also require await.

API Limits¶

JavaScript calls are subject to rate and size limits. Use batch operations (batchAppendRows, batchUpdateRows, batchDeleteRows) whenever possible to reduce the number of API calls.