Skip to content

PHP Client

SeaTable's API exposes the entire SeaTable features via a standardized programmatic interface. The SeaTable PHP Client encapsulates SeaTable Server Restful API. If you are familiar this client enables you to call every available API endpoint of SeaTable. You can interact with the user accounts, bases or files.

Auto generated from openapi specification

Since April 2024, we auto generate this SeaTable php client from our public available openapi specification. The advantage is that, the php client automatically contains all available API endpoints and we save a lot of programming capacity. Also we could generate more api clients for other programming languages in no time with the same feature set. The disadvantage is, that with this new client we removed some convenitent functions for authentication and the new version is not compatible at all with the version v0.2 and earlier.

Installation

The SeaTable API installs as part of your project dependencies. It is available from Packagist and can be installed with Composer:

composer require seatable/seatable-api-php

The source code of the PHP Client API is available at GitHub.

Getting Started

After installation you can easily connect to your SeaTable system and execute API calls.

Get information about your account

The following code connects to SeaTable Cloud. You have to provide your Account Token.

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCOUNT_TOKEN');

$apiInstance = new SeaTable\Client\User\UserApi(new GuzzleHttp\Client(), $config);

try {
    $result = $apiInstance->getAccountInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getAccountInfo: ', $e->getMessage(), PHP_EOL;
}

List your bases

This time, we connect to a self-hosted SeaTable Server.

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer authorization: AccountTokenAuth
$config = SeaTable\Client\Configuration::getDefaultConfiguration();
$config->setAccessToken('YOUR_ACCOUNT_TOKEN');
$config->setHost('https://seatable.example.com');

$apiInstance = new SeaTable\Client\User\BasesApi(new GuzzleHttp\Client(), $config);

try {
    $result = $apiInstance->listBases();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BasesApi->listBases: ', $e->getMessage(), PHP_EOL;
}

Get Metadata from your Base

First we have to get the Base-Token and the base_uuid and then we can execute the getMetadata call.

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Base Token
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_API_TOKEN');

$apiInstance = new SeaTable\Client\Auth\BaseTokenApi(new GuzzleHttp\Client(), $config);

try {
    $result = $apiInstance->getBaseTokenWithApiToken();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BaseTokenApi->getBaseTokenWithApiToken: ', $e->getMessage(), PHP_EOL;
}

// Metadata
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken($result['access_token']);
$apiInstance = new SeaTable\Client\Base\BaseInfoApi(new GuzzleHttp\Client(), $config);

try {
    $result = $apiInstance->getMetadata($result['dtable_uuid']);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BaseInfoApi->getMetadata: ', $e->getMessage(), PHP_EOL;
}

Execute SQL-Query against your base

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Base Token
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_API_TOKEN');

$apiInstance = new SeaTable\Client\Auth\BaseTokenApi(new GuzzleHttp\Client(), $config);

try {
    $result = $apiInstance->getBaseTokenWithApiToken();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BaseTokenApi->getBaseTokenWithApiToken: ', $e->getMessage(), PHP_EOL;
}

// Base query
$config = SeaTable\Client\Configuration::getDefaultConfiguration()->setAccessToken($result['access_token']);

$apiInstance = new SeaTable\Client\Base\RowsApi(new GuzzleHttp\Client(), $config);

$base_uuid = $result['dtable_uuid'];
$sql_query = new \SeaTable\Client\Model\SqlQuery(["sql" => "Select * from Table1", "convert_keys" => false]);

try {
    $result = $apiInstance->querySQL($base_uuid, $sql_query);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RowsApi->querySQL: ', $e->getMessage(), PHP_EOL;
}

API Endpoints - Auth

Class Method HTTP request Description
APITokenApi createApiToken POST /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/api-tokens/ Create API-Token
APITokenApi createTempApiToken GET /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/temp-api-token/ Create API-Token (temporary)
APITokenApi deleteApiToken DELETE /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/api-tokens/{app_name}/ Delete API-Token
APITokenApi listApiTokens GET /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/api-tokens/ List API-Tokens
APITokenApi updateApiToken PUT /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/api-tokens/{app_name}/ Update API-Token
AccountTokenApi getAccountTokenfromUsername POST /api2/auth-token/ Get Account-Token with Username and Password
BaseTokenApi getBaseTokenWithAccountToken GET /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/access-token/ Get Base-Token with Account-Token
BaseTokenApi getBaseTokenWithApiToken GET /api/v2.1/dtable/app-access-token/ Get Base-Token with API-Token
BaseTokenApi getBaseTokenWithExternLink GET /api/v2.1/external-link-tokens/{external_link_token}/access-token/ Get Base-Token with External-Link

API Endpoints - Base

Class Method HTTP request Description
ActivitiesLogsApi getBaseActivityLog GET /dtable-server/api/v1/dtables/{base_uuid}/operations/ Get Base Activity Log
ActivitiesLogsApi listDeleteOperations GET /api/v2.1/dtables/{base_uuid}/delete-operation-logs/ List Delete Operations
ActivitiesLogsApi listDeletedRows GET /dtable-server/api/v1/dtables/{base_uuid}/deleted-rows/ List Deleted Rows
ActivitiesLogsApi listRowActivities GET /dtable-server/api/v1/dtables/{base_uuid}/activities/ List Row Activities
BaseInfoApi getBaseInfo GET /dtable-server/dtables/{base_uuid} Get Base Info
BaseInfoApi getBigDataStatus GET /dtable-db/api/v1/base-info/{base_uuid}/ Get Big Data Status
BaseInfoApi getMetadata GET /dtable-server/api/v1/dtables/{base_uuid}/metadata/ Get Metadata
BaseInfoApi listCollaborators GET /dtable-server/api/v1/dtables/{base_uuid}/related-users/ List Collaborators
BigDataApi createBigDataRowsLink POST /dtable-db/api/v1/base/{base_uuid}/links/ Create Row Links in Big Data
BigDataApi deleteBigDataRowLinks DELETE /dtable-db/api/v1/base/{base_uuid}/links/ Delete Row Links in Big Data
BigDataApi deleteBigDataRows DELETE /dtable-db/api/v1/delete-rows/{base_uuid}/ Delete Rows in Big Data
BigDataApi insertBigDataRows POST /dtable-db/api/v1/insert-rows/{base_uuid}/ Insert Rows into Big Data
BigDataApi moveRowsToBigData POST /dtable-server/api/v1/dtables/{base_uuid}/archive-view/ Move Rows to Big Data
BigDataApi updateBigDataRows PUT /dtable-db/api/v1/update-rows/{base_uuid}/ Update Rows in Big Data
ColumnsApi addSelectOption POST /dtable-server/api/v1/dtables/{base_uuid}/column-options/ Add Single/Multiple Select Options
ColumnsApi appendColumns POST /dtable-server/api/v1/dtables/{base_uuid}/batch-append-columns/ Append Columns
ColumnsApi deleteColumn DELETE /dtable-server/api/v1/dtables/{base_uuid}/columns/ Delete Column
ColumnsApi deleteSelectOption DELETE /dtable-server/api/v1/dtables/{base_uuid}/column-options/ Delete Single/Multiple Select Options
ColumnsApi insertColumn POST /dtable-server/api/v1/dtables/{base_uuid}/columns/ Insert Column
ColumnsApi listColumns GET /dtable-server/api/v1/dtables/{base_uuid}/columns/ List Columns
ColumnsApi updateColumn PUT /dtable-server/api/v1/dtables/{base_uuid}/columns/ Update Column
ColumnsApi updateColumnCascade POST /dtable-server/api/v1/dtables/{base_uuid}/column-cascade-settings/ Update Column Cascade
ColumnsApi updateSelectOption PUT /dtable-server/api/v1/dtables/{base_uuid}/column-options/ Update Single/Multiple Select Options
LinksApi createRowLink POST /dtable-server/api/v1/dtables/{base_uuid}/links/ Create Row Link
LinksApi createRowLinks PUT /dtable-server/api/v1/dtables/{base_uuid}/links/ Create Row Links
LinksApi deleteRowLink DELETE /dtable-server/api/v1/dtables/{base_uuid}/links/ Delete Row Link
LinksApi listRowLinks POST /dtable-db/api/v1/linked-records/{base_uuid} List Row Links
LinksApi updateRowLinks PUT /dtable-server/api/v1/dtables/{base_uuid}/batch-update-links/ Update Row Links (Batch)
NotificationsApi deleteBaseNotifications DELETE /dtable-server/api/v1/dtables/{base_uuid}/notifications/ Delete Base Notifications
NotificationsApi listBaseNotifications GET /dtable-server/api/v1/dtables/{base_uuid}/notifications/ List Base Notifications
NotificationsApi markBaseNotificationAsSeen PUT /dtable-server/api/v1/dtables/{base_uuid}/notifications/{notification_id}/ Mark Notification Read/Unread
NotificationsApi markBaseNotificationsAsSeen PUT /dtable-server/api/v1/dtables/{base_uuid}/notifications/ Mark Base Notifications as seen
RowCommentsApi deleteComment DELETE /dtable-server/api/v1/dtables/{base_uuid}/comments/{comment_id}/ Delete Comment
RowCommentsApi getComment GET /dtable-server/api/v1/dtables/{base_uuid}/comments/{comment_id}/ Get Comment
RowCommentsApi getRowCommentsCount GET /dtable-server/api/v1/dtables/{base_uuid}/comments-count/ Get Row Comments Count
RowCommentsApi listCommentsWithinDays GET /dtable-server/api/v1/dtables/{base_uuid}/comments-within-days/ List Comments within Days
RowCommentsApi listRowComments GET /dtable-server/api/v1/dtables/{base_uuid}/comments/ List Row Comments
RowsApi addRow POST /dtable-server/api/v1/dtables/{base_uuid}/rows/ Add Row
RowsApi appendRows POST /dtable-server/api/v1/dtables/{base_uuid}/batch-append-rows/ Append Rows
RowsApi deleteRow DELETE /dtable-server/api/v1/dtables/{base_uuid}/rows/ Delete Row
RowsApi deleteRows DELETE /dtable-server/api/v1/dtables/{base_uuid}/batch-delete-rows/ Delete Rows
RowsApi getRow GET /dtable-server/api/v1/dtables/{base_uuid}/rows/{row_id}/ Get Row
RowsApi listFilteredRows GET /dtable-server/api/v1/dtables/{base_uuid}/filtered-rows/ List Filtered Rows
RowsApi listRows GET /dtable-server/api/v1/dtables/{base_uuid}/rows/ List Rows
RowsApi lockRows PUT /dtable-server/api/v1/dtables/{base_uuid}/lock-rows/ Lock Rows
RowsApi querySQL POST /dtable-db/api/v1/query/{base_uuid}/ List Rows (with SQL)
RowsApi unlockRows PUT /dtable-server/api/v1/dtables/{base_uuid}/unlock-rows/ Unlock Rows
RowsApi updateRow PUT /dtable-server/api/v1/dtables/{base_uuid}/rows/ Update Row
RowsApi updateRows PUT /dtable-server/api/v1/dtables/{base_uuid}/batch-update-rows/ Update Rows
SnapshotsApi createSnapshot POST /dtable-server/api/v1/dtables/{base_uuid}/snapshot/ Create Snapshot
TablesApi createTable POST /dtable-server/api/v1/dtables/{base_uuid}/tables/ Create Table
TablesApi deleteTable DELETE /dtable-server/api/v1/dtables/{base_uuid}/tables/ Delete Table
TablesApi duplicateTable POST /dtable-server/api/v1/dtables/{base_uuid}/tables/duplicate-table/ Duplicate Table
TablesApi renameTable PUT /dtable-server/api/v1/dtables/{base_uuid}/tables/ Rename Table
ViewsApi createView POST /dtable-server/api/v1/dtables/{base_uuid}/views/ Create View
ViewsApi deleteView DELETE /dtable-server/api/v1/dtables/{base_uuid}/views/{view_name}/ Delete View
ViewsApi getView GET /dtable-server/api/v1/dtables/{base_uuid}/views/{view_name}/ Get View
ViewsApi listViews GET /dtable-server/api/v1/dtables/{base_uuid}/views/ List Views
ViewsApi updateView PUT /dtable-server/api/v1/dtables/{base_uuid}/views/{view_name}/ Update View

API Endpoints - SysAdmin

Class Method HTTP request Description
AutomationsApi deleteAutomation DELETE /api/v2.1/admin/automation-rules/{automation_rule_id}/ Delete Automation
AutomationsApi deleteInvalidAutomations DELETE /api/v2.1/admin/invalid-automation-rules/ Delete Invalid Automations
AutomationsApi listAutomations GET /api/v2.1/admin/automation-rules/ List Automations
AutomationsApi listInvalidAutomations GET /api/v2.1/admin/invalid-automation-rules/ List Invalid Automations
BasesApi deleteBase DELETE /api/v2.1/admin/dtable/{base_uuid}/ Delete Base
BasesApi deleteBasePassword PUT /api/v2.1/admin/dtable/{base_uuid}/unset-password/ Delete Base Password
BasesApi listAllBases GET /api/v2.1/admin/dtables/ List All Bases
BasesApi listBaseNotifications GET /api/v2.1/admin/dtable-notifications/ List Notifications
BasesApi listTrashedBases GET /api/v2.1/admin/trash-dtables/ List Trashed Bases
BasesApi listUsersBases GET /api/v2.1/admin/users/{user_id}/dtables/ List User's Bases
BasesApi restoreTrashedBase PUT /api/v2.1/admin/trash-dtables/{base_id}/ Restore Trashed Base
CommonDatasetApi deleteInvalidSync DELETE /api/v2.1/admin/common-dataset/sync/{sync_id}/ Delete Invalid Sync
CommonDatasetApi deleteInvalidSyncs DELETE /api/v2.1/admin/common-dataset/invalid-syncs/ Delete Invalid Syncs
CommonDatasetApi listCommonDataset GET /api/v2.1/admin/common-datasets/ List Common Dataset
CommonDatasetApi listCommonDatasetSyncs GET /api/v2.1/admin/common-dataset/periodical-syncs/ List Common Dataset Syncs
CommonDatasetApi listInvalidSyncs GET /api/v2.1/admin/common-dataset/invalid-syncs/ List invalid Syncs
DepartmentsApi addDepartment POST /api/v2.1/admin/address-book/groups/ Add Department
DepartmentsApi deleteDepartment DELETE /api/v2.1/admin/address-book/groups/{department_id}/ Delete Department
DepartmentsApi getDepartments GET /api/v2.1/admin/address-book/groups/{department_id}/ Get Department
DepartmentsApi listDepartments GET /api/v2.1/admin/address-book/groups/{parent_department_id}/ List Departments
ExportApi exportBase GET /api/v2.1/admin/dtables/{base_uuid}/synchronous-export/export-dtable/ Export base
FormsApi deleteDataCollectionForms DELETE /api/v2.1/admin/collection-tables/{collection_table_token}/ Delete Data Collection Forms
FormsApi deleteForm DELETE /api/v2.1/admin/forms/{form_token}/ Delete Form
FormsApi listDataCollectionForms GET /api/v2.1/admin/collection-tables/ List Data Collection Forms
FormsApi listForms GET /api/v2.1/admin/forms/ List Forms
GroupsApi createGroup POST /api/v2.1/admin/groups/ Create Group
GroupsApi deleteGroup DELETE /api/v2.1/admin/groups/{group_id}/ Delete Group
GroupsApi listGroups GET /api/v2.1/admin/groups/ List Groups
GroupsApi transferGroup PUT /api/v2.1/admin/groups/{group_id}/ Transfer Group
LogsApi listAbuseReports GET /api/v2.1/admin/abuse-reports/ List Abuse Reports
LogsApi listEmailLogs GET /api/v2.1/admin/email-sending-logs/ List Email Logs
LogsApi listLoginLogs GET /api/v2.1/admin/logs/login-logs/ List Login Logs
LogsApi listRegistrationLogs GET /api/v2.1/admin/registration-logs/ List Registration Logs
LogsApi updateAbuseReport PUT /api/v2.1/admin/abuse-reports/{abuse_report_id}/ Update Abuse Report
NotificationsApi deleteInvalidNotifications DELETE /api/v2.1/admin/invalid-notification-rules/ Delete Invalid Notifications
NotificationsApi deleteNotificationRule DELETE /api/v2.1/admin/notification-rules/{notification_rule_id}/ Delete Notification
NotificationsApi listInvalidNotifications GET /api/v2.1/admin/invalid-notification-rules/ List Invalid Notifications
NotificationsApi listNotificationRules GET /api/v2.1/admin/notification-rules/ List Notification Rules
PluginsApi addPlugin POST /api/v2.1/admin/dtable-system-plugins/ Add Plugin
PluginsApi deletePlugin DELETE /api/v2.1/admin/dtable-system-plugins/{plugin_id}/ Delete Plugin
PluginsApi listPlugins GET /api/v2.1/admin/dtable-system-plugins/ List Plugins
PluginsApi listPluginsInstallCount GET /api/v2.1/admin/plugins-install-count/ List Plugins Install Count
PluginsApi updatePlugin PUT /api/v2.1/admin/dtable-system-plugins/{plugin_id}/ Update Plugin
SharingLinksApi deleteBaseExternalLink DELETE /api/v2.1/admin/external-links/{external_link_token}/ Delete Base External Link
SharingLinksApi deleteViewExternalLink DELETE /api/v2.1/admin/view-external-links/{view_external_link_token}/ Delete View External Link
SharingLinksApi listBaseExternalLinks GET /api/v2.1/admin/dtable/{base_id}/external-links/ List Base External Links
SharingLinksApi listExternalLinks GET /api/v2.1/admin/external-links/ List External Links
SharingLinksApi listViewExternalLinks GET /api/v2.1/admin/view-external-links/ List View External Links
StatisticsApi getActiveUsersPerDay GET /api/v2.1/admin/statistics/active-users/ Get Active Users (per Day)
StatisticsApi getAutomationRules GET /api/v2.1/admin/statistics/auto-rules/ Get Automation Rules
StatisticsApi getExternalApps GET /api/v2.1/admin/statistics/external-apps/ Get External Apps
StatisticsApi getScriptRunningCountByUser GET /api/v2.1/admin/statistics/scripts-running/ Get Script Running Count by User
StatisticsApi listActiveUsersByDay GET /api/v2.1/admin/daily-active-users/ List Active Users (one Day)
StatisticsApi listScriptTasks GET /api/v2.1/admin/scripts-tasks/ List Scripts Tasks
SystemInfoCustomizingApi getSystemInformation GET /api/v2.1/admin/sysinfo/ Get system information
SystemInfoCustomizingApi updateFavicon POST /api/v2.1/admin/favicon/ Update Favicon
SystemInfoCustomizingApi updateGeneralSettings PUT /api/v2.1/admin/web-settings/ Update General Settings
SystemInfoCustomizingApi updateLoginBackgroundImage POST /api/v2.1/admin/login-background-image/ Update Login Background Image
SystemInfoCustomizingApi updateLogo POST /api/v2.1/admin/logo/ Update Logo
SystemNotificationsApi addNotificationToUser POST /api/v2.1/admin/sys-user-notifications/ Add Notification to User
SystemNotificationsApi deleteNotification DELETE /api/v2.1/admin/sys-user-notifications/{sys_notification_id}/ Delete Notification
SystemNotificationsApi listNotifications GET /api/v2.1/admin/sys-user-notifications/ List Notifications
TeamsApi addTeam POST /api/v2.1/admin/organizations/ Add Team
TeamsApi addTeamUser POST /api/v2.1/admin/organizations/{org_id}/users/ Add Team User
TeamsApi deleteTeam DELETE /api/v2.1/admin/organizations/{org_id}/ Delete Team
TeamsApi deleteTeamGroup DELETE /api/v2.1/admin/organizations/{org_id}/groups/{group_id}/ Delete Group
TeamsApi deleteTeamUser DELETE /api/v2.1/admin/organizations/{org_id}/users/{user_id}/ Delete Team User
TeamsApi getOrganizationNames GET /api/v2.1/admin/organizations-basic-info/ Get Organization Names
TeamsApi listTeamBases GET /api/v2.1/admin/organizations/{org_id}/dtables/ List Team Bases
TeamsApi listTeamGroups GET /api/v2.1/admin/organizations/{org_id}/groups/ List Team Groups
TeamsApi listTeamUsers GET /api/v2.1/admin/organizations/{org_id}/users/ List Team Users
TeamsApi listTeams GET /api/v2.1/admin/organizations/ List Teams
TeamsApi searchTeam GET /api/v2.1/admin/organizations/{org_id}/ Search Team
TeamsApi updateTeam PUT /api/v2.1/admin/organizations/{org_id}/ Update Team
TeamsApi updateTeamUser PUT /api/v2.1/admin/organizations/{org_id}/users/{user_id}/ Update Team User
UsersApi addNewUser POST /api/v2.1/admin/users/ Add New User
UsersApi deleteUser DELETE /api/v2.1/admin/users/{user_id}/ Delete User
UsersApi disableTwoFactor DELETE /api2/two-factor-auth/{user_id}/ Disable 2FA
UsersApi enforceTwoFactor PUT /api/v2.1/admin/users/{user_id}/two-factor-auth/ Enforce 2FA
UsersApi getUser GET /api/v2.1/admin/users/{user_id}/ Get User
UsersApi importUsers POST /api/v2.1/admin/import-users/ Import users
UsersApi listAdminUsers GET /api/v2.1/admin/admin-users/ List Admin Users
UsersApi listBasesSharedToUser GET /api/v2.1/admin/users/{user_id}/shared-dtables/ List Bases Shared to User
UsersApi listUserStorageObjects GET /api/v2.1/admin/users/{user_id}/storage/ List User's Storage Objects
UsersApi listUsers GET /api/v2.1/admin/users/ List Users
UsersApi resetUserPassword PUT /api/v2.1/admin/users/{user_id}/reset-password/ Reset User's Password
UsersApi searchUser GET /api/v2.1/admin/search-user/ Search User / Users
UsersApi searchUserByOrgId GET /api/v2.1/admin/search-user-by-org-id/ Search User by Org-ID
UsersApi updateAdminRole PUT /api/v2.1/admin/admin-role/ Update Admin's Role
UsersApi updateUser PUT /api/v2.1/admin/users/{user_id}/ Update User

API Endpoints - TeamAdmin

Class Method HTTP request Description
ActivitiesLogsApi listTeamLogins GET /api/v2.1/org/{org_id}/admin/login-logs/ List Team Logins
ActivitiesLogsApi listTeamOperationLog GET /api/v2.1/org/{org_id}/admin/admin-logs/ List Team Operations
ActivitiesLogsApi listUserLogins GET /api/v2.1/org/{org_id}/admin/login-logs/{user_id} List User Logins
BasesApi clearTeamTrashBin DELETE /api/v2.1/org/{org_id}/admin/trash-dtables/ Clear Team Trash Bin
BasesApi deleteBase DELETE /api/v2.1/org/{org_id}/admin/dtables/{base_id}/ Delete Base
BasesApi listBaseSharings GET /api/v2.1/org/{org_id}/admin/dtables/{base_uuid}/shares List Base Sharings
BasesApi listBases GET /api/v2.1/org/{org_id}/admin/dtables/ List Bases (Team)
BasesApi listTrashBases GET /api/v2.1/org/{org_id}/admin/trash-dtables/ List Trash Bases
BasesApi restoreBaseFromTrash PUT /api/v2.1/org/{org_id}/admin/trash-dtables/{base_id}/ Restore Base from Trash
BasesApi searchBase GET /api/v2.1/org/{org_id}/admin/search-dtables/ Search Base
CustomizingApi deleteTeamLogo DELETE /api/v2.1/org/{org_id}/admin/org-logo/ Delete Team Logo
CustomizingApi getTeamLogo GET /api/v2.1/org/{org_id}/admin/org-logo/ Get Team Logo
CustomizingApi updateTeamLogo POST /api/v2.1/org/{org_id}/admin/org-logo/ Update Team Logo
GroupsApi addGroup POST /api/v2.1/org/{org_id}/admin/groups/ Add Group
GroupsApi addGroupMembers POST /api/v2.1/org/{org_id}/admin/groups/{group_id}/members/ Add Group Members
GroupsApi deleteGroup DELETE /api/v2.1/org/{org_id}/admin/groups/{group_id}/ Delete Group
GroupsApi getGroup GET /api/v2.1/org/{org_id}/admin/groups/{group_id}/ Get Group
GroupsApi listGroupBases GET /api/v2.1/org/{org_id}/admin/groups/{group_id}/dtables/ List Group Bases
GroupsApi listGroupMembers GET /api/v2.1/org/{org_id}/admin/groups/{group_id}/members/ List Group Members
GroupsApi listGroups GET /api/v2.1/org/{org_id}/admin/groups/ List Groups (Team)
GroupsApi orderGroups PUT /api/v2.1/groups/move-group/ Re-order Your Groups
GroupsApi removeGroupMembers DELETE /api/v2.1/org/{org_id}/admin/groups/{group_id}/members/{user_id}/ Remove Group Members
GroupsApi updateGroup PUT /api/v2.1/org/{org_id}/admin/groups/{group_id}/ Update Group
InfoSettingsApi getTeamInfo GET /api/v2.1/org/admin/info/ Get Team Info
InfoSettingsApi getTeamSettings GET /api/v2.1/org/admin/settings/ Get Team Settings
InfoSettingsApi updateTeam PUT /api/v2.1/org/admin/info/ Update Team
InfoSettingsApi updateTeamSettings PUT /api/v2.1/org/admin/settings/ Update Team Settings
SAMLApi getSamlConfig GET /api/v2.1/org/{org_id}/admin/saml-config/ Get SAML Config
SAMLApi updateSamlConfig PUT /api/v2.1/org/{org_id}/admin/saml-config/ Update SAML Config
SAMLApi verifySamlDomain PUT /api/v2.1/org/{org_id}/admin/verify-domain/ Verify SAML domain
SharingLinksApi deleteExternalLink DELETE /api/v2.1/org/{org_id}/admin/external-links/{external_link_token}/ Delete External Link
SharingLinksApi deleteInviteLink DELETE /api/v2.1/org/{org_id}/admin/invite-links/{invite_link_token}/ Delete Invite Link
SharingLinksApi deleteViewExternalLink DELETE /api/v2.1/org/{org_id}/admin/view-external-links/{view_external_link_token}/ Delete View External Link
SharingLinksApi listBaseExternalLinks GET /api/v2.1/org/{org_id}/admin/external-links/ List Base External Links
SharingLinksApi listInviteLinks GET /api/v2.1/org/{org_id}/admin/invite-links/ List Invite Links
SharingLinksApi listViewExternalLinks GET /api/v2.1/org/{org_id}/admin/view-external-links/ List View External Links
SharingLinksApi updateInviteLink PUT /api/v2.1/org/{org_id}/admin/invite-links/{invite_link_token}/ Update Invite Link
UsersApi addUser POST /api/v2.1/org/{org_id}/admin/users/ Add User
UsersApi deleteUser DELETE /api/v2.1/org/{org_id}/admin/users/{user_id}/ Delete User
UsersApi disableTwoFactor DELETE /api/v2.1/org/{org_id}/admin/users/{user_id}/two-factor-auth/ Disable 2FA
UsersApi enforceTwofactor PUT /api/v2.1/org/{org_id}/admin/users/{user_id}/two-factor-auth/ Enforce 2FA
UsersApi listTeamUsers GET /api/v2.1/org/{org_id}/admin/users/ List Users (Team)
UsersApi resetUserPassword PUT /api/v2.1/org/{org_id}/admin/users/{user_id}/set-password/ Reset User Password
UsersApi updateUser PUT /api/v2.1/org/{org_id}/admin/users/{user_id}/ Update User

API Endpoints - User

Class Method HTTP request Description
ActivitiesLogsApi getBaseActivities GET /api/v2.1/dtable-activities/ Get Base Activities
ActivitiesLogsApi getBaseActivityDetails GET /api/v2.1/dtable-activities/detail Get Base Activity Details
AppsApi changeAppStatus PUT /api/v2.1/external-apps/{app_token}/status/ Change App Status
AppsApi importUsersToApp POST /api/v2.1/universal-apps/{app_token}/app-users/batch/ Import Users to App
AppsApi listAppInviteLinks GET /api/v2.1/universal-apps/{app_token}/invite-links/ List App Invite Links
AppsApi listApps GET /api/v2.1/universal-apps/ List Apps
AppsApi listUniversalAppUsers GET /api/v2.1/universal-apps/{app_token}/app-users/ List Universal App Users
AttachmentApi checkIfAssetExists GET /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/asset-exists/ Check If Asset Exists
AttachmentApi deleteBaseAsset DELETE /api/v2.1/dtable-asset/{base_uuid}/ Delete Base Asset
AttachmentApi deleteBaseAssets DELETE /api/v2.1/dtable-asset/{base_uuid}/batch-delete-assets/ Delete Base Assets
AttachmentApi getBaseAttachmentUploadLink GET /api/v2.1/workspace/{workspace_id}/dtable-asset-upload-link/ Get Base Attachment Upload Link
AttachmentApi listBaseAssets GET /api/v2.1/dtable-asset/{base_uuid}/ List Base Asset Directories And Files
AttachmentApi listRecentlyUploadedFiles GET /api/v2.1/dtable-recent-asset/{base_uuid}/ List Recently Uploaded Files
AttachmentApi renameBaseAsset POST /api/v2.1/dtable-asset/{base_uuid}/rename/ Rename Base Asset
AutomationsApi createAutomationRule POST /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/automation-rules/ Create Automation Rule
AutomationsApi deleteAutomationRule DELETE /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/automation-rules/{automation_rule_id}/ Delete Automation Rule
AutomationsApi listAutomationRules GET /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/automation-rules/ List Automation Rules
AutomationsApi updateAutomationRule PUT /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/automation-rules/{automation_rule_id}/ Update Automation Rule
BasesApi basePassword PUT /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/password/ Base Password
BasesApi clearTrash DELETE /api/v2.1/trash-dtables/ Clear Trash
BasesApi createBase POST /api/v2.1/dtables/ Create Base
BasesApi createFolder POST /api/v2.1/workspace/{workspace_id}/folders/ Create Folder
BasesApi deleteBase DELETE /api/v2.1/workspace/{workspace_id}/dtable/ Delete Base
BasesApi deleteFolder DELETE /api/v2.1/workspace/{workspace_id}/folders/{folder_id}/ Delete Folder
BasesApi favoriteBase POST /api/v2.1/starred-dtables/ Favorite Base
BasesApi listBases GET /api/v2.1/user-admin-dtables/ List Bases
BasesApi listFavorites GET /api/v2.1/starred-dtables/ List Favorites
BasesApi listGroupTrashedBases GET /api/v2.1/groups/{group_id}/trash-dtables/ List Group Trashed Bases
BasesApi listTrashedBases GET /api/v2.1/trash-dtables/ List Trashed Bases
BasesApi moveBaseIntoFolder POST /api/v2.1/workspace/{workspace_id}/folder-item-moving/ Move Base into Folder
BasesApi restoreGroupTrashedBase PUT /api/v2.1/groups/{group_id}/trash-dtables/{base_uuid}/ Restore Group Trashed Base
BasesApi restoreTrashedBase PUT /api/v2.1/trash-dtables/{trashed_base_id}/ Restore Trashed Base
BasesApi searchBaseOrApps GET /api/v2.1/dtable/items-search/ Search base or apps
BasesApi unfavoriteBase DELETE /api/v2.1/starred-dtables/ Unfavorite Base
BasesApi updateBase PUT /api/v2.1/workspace/{workspace_id}/dtable/ Update Base
BasesApi updateFolder PUT /api/v2.1/workspace/{workspace_id}/folders/{folder_id}/ Update Folder
CommonDatasetApi deleteCommonDataset DELETE /api/v2.1/dtable/common-datasets/{dataset_id}/ Delete Common Dataset
CommonDatasetApi getCommonDataset GET /api/v2.1/dtable/common-datasets/{dataset_id}/ Get Common Dataset
CommonDatasetApi getCommonDatasetInfo GET /api/v2.1/dtable/common-datasets/{dataset_id}/info/ Get Common Dataset Info
CommonDatasetApi importCommonDataset POST /api/v2.1/dtable/common-datasets/{dataset_id}/import/ Import Common Dataset
CommonDatasetApi listCommonDataset GET /api/v2.1/dtable/common-datasets/ List Common Datasets
CommonDatasetApi listSyncHistory GET /api/v2.1/dtable/common-datasets/syncs/ List Sync History
CommonDatasetApi publishCommonDataset POST /api/v2.1/dtable/common-datasets/ Publish Common Dataset
CommonDatasetApi renameCommonDataset PUT /api/v2.1/dtable/common-datasets/{dataset_id}/ Rename Common Dataset
CommonDatasetApi syncCommonDataset POST /api/v2.1/dtable/common-datasets/{dataset_id}/sync/ Sync Common Dataset
CommonDatasetApi updateCommonDatasetSync PUT /api/v2.1/dtable/common-datasets/{dataset_id}/sync/ Update Common Dataset Sync
DepartmentsApi listDeparmentMembers GET /api/v2.1/address-book/departments/{department_id}/members/ List Deparment Members
DepartmentsApi listDepartments GET /api/v2.1/address-book/departments/ List Departments
EmailAccountsApi addEmailAccount POST /api/v2.1/third-party-accounts/{base_uuid}/ Add Email Account
EmailAccountsApi deleteEmailAccount DELETE /api/v2.1/third-party-accounts/{base_uuid}/{3rd_party_account_id}/ Delete Email Account
EmailAccountsApi getEmailAccount GET /api/v2.1/third-party-accounts/{base_uuid}/detail/ Get Email Account
EmailAccountsApi getEmailSendingStatus GET /api/v2.1/dtable-message-status/ Get Email Sending Status
EmailAccountsApi listEmailAccounts GET /api/v2.1/third-party-accounts/{base_uuid}/ List Email Accounts
EmailAccountsApi updateEmailAccount PUT /api/v2.1/third-party-accounts/{base_uuid}/{3rd_party_account_id}/ Update Email Account
FormsApi createForm POST /api/v2.1/forms/ Create Form
FormsApi deleteForm DELETE /api/v2.1/forms/{form_token}/ Delete Form
FormsApi duplicateForm POST /api/v2.1/forms/{form_token}/duplicate/ Duplicate Form
FormsApi listForms GET /api/v2.1/forms/ List Forms
FormsApi listSharedForms GET /api/v2.1/forms/shared/ List Shared Forms
FormsApi updateForm PUT /api/v2.1/forms/{form_token}/ Update Form
FormsApi uploadFormLogo POST /api/v2.1/forms/{form_token}/logos/ Upload Form Logo
GroupsWorkspacesApi addGroupMember POST /api/v2.1/groups/{group_id}/members/ Add Group Member
GroupsWorkspacesApi copyBaseFromExternalLink POST /api/v2.1/dtable-external-link/dtable-copy/ Copy Base from External Link
GroupsWorkspacesApi copyBaseFromWorkspace POST /api/v2.1/dtable-copy/ Copy Base from Workspace
GroupsWorkspacesApi createGroup POST /api/v2.1/groups/ Create Group
GroupsWorkspacesApi deleteGroup DELETE /api/v2.1/groups/{group_id}/ Delete Group
GroupsWorkspacesApi getGroup GET /api/v2.1/groups/{group_id}/ Get Group
GroupsWorkspacesApi getGroupMembers GET /api/v2.1/groups/{group_id}/members/ Get Group Members
GroupsWorkspacesApi listGroups GET /api/v2.1/groups/ List Groups
GroupsWorkspacesApi listWorkspaces GET /api/v2.1/workspaces/ List Workspaces
GroupsWorkspacesApi removeGroupMember DELETE /api/v2.1/groups/{group_id}/members/{group_member}/ Remove Group Member
GroupsWorkspacesApi searchGroup GET /api/v2.1/search-group/ Search Group
GroupsWorkspacesApi searchGroupMembers GET /api/v2.1/groups/{group_id}/search-member/ Search Group Members
GroupsWorkspacesApi updateGroup PUT /api/v2.1/groups/{group_id}/ Update Group
GroupsWorkspacesApi updateGroupRole PUT /api/v2.1/groups/{group_id}/members/{group_member}/ Update Group Role
ImportExportApi appendToTableFromFile POST /api/v2.1/workspace/{workspace_id}/synchronous-import/append-excel-csv-to-table/ Append Excel CSV
ImportExportApi exportBase GET /api/v2.1/workspace/{workspace_id}/synchronous-export/export-dtable/ Export Base
ImportExportApi exportBaseFromExternalLink GET /dtable/external-links/{external_link_token}/download-zip/ Export Base from External Link
ImportExportApi exportBigDataView GET /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/convert-big-data-view-to-excel/ Export Big Data View to Excel
ImportExportApi exportTable GET /api/v2.1/workspace/{workspace_id}/synchronous-export/export-table-to-excel/ Export Table
ImportExportApi exportView GET /api/v2.1/workspace/{workspace_id}/synchronous-export/export-view-to-excel/ Export View
ImportExportApi importBasefromFile POST /api/v2.1/workspace/{workspace_id}/synchronous-import/import-excel-csv-to-base/ Import Base from xlsx or csv
ImportExportApi importTableFromFile POST /api/v2.1/workspace/{workspace_id}/synchronous-import/import-excel-csv-to-table/ Import Table from xlsx or csv
ImportExportApi updateFromFile POST /api/v2.1/workspace/{workspace_id}/synchronous-import/update-table-via-excel-csv/ Update from xlsx or csv
NotificationsApi addNotificationRule POST /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/notification-rules/ Add Notification Rule
NotificationsApi deleteNotificationRule DELETE /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/notification-rules/{notification_rule_id}/ Delete Notification Rule
NotificationsApi listNotificationRules GET /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/notification-rules/ List Notification Rules
NotificationsApi markNotificationAsSeen DELETE /api/v2.1/notifications/ Mark Notifications As Seen
NotificationsApi updateNotificationRule PUT /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/notification-rules/{notification_rule_id}/ Update Notification Rule
SharingApi createGroupShare POST /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/group-shares/ Create Group Share
SharingApi createGroupViewShare POST /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/group-view-shares/ Create Group View Share
SharingApi createUserShare POST /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/share/ Create User Share
SharingApi createUserViewShare POST /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/user-view-shares/ Create User View Share
SharingApi deleteGroupAllViewShare DELETE /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/group-view-shares/ Delete Group View Share
SharingApi deleteGroupShare DELETE /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/group-shares/{group_id}/ Delete Group Share
SharingApi deleteGroupViewShare DELETE /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/group-view-shares/{group_view_share_id}/ Delete Group View Share
SharingApi deleteUserAllViewShare DELETE /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/user-view-shares/ Delete User View Share
SharingApi deleteUserShare DELETE /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/share/ Delete User Share
SharingApi deleteUserViewShare DELETE /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/user-view-shares/{user_view_share_id}/ Delete User View Share
SharingApi leaveSharedView DELETE /api/v2.1/dtables/view-shares-user-shared/{user_view_share_id}/ Leave Shared View
SharingApi listCollaborators GET /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/related-users/ List Collaborators
SharingApi listGroupShares GET /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/group-shares/ List Group Shares
SharingApi listGroupViewShares GET /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/group-view-shares/ List Group View Shares
SharingApi listMyGroupShares GET /api/v2.1/dtables/group-shared/ List My Group Shares
SharingApi listMyGroupViewShares GET /api/v2.1/dtables/view-shares-group-shared/ My Group View Shares
SharingApi listMyShares GET /api/v2.1/dtables/shared/ List My Shares
SharingApi listMyUserViewShares GET /api/v2.1/dtables/view-shares-user-shared/ List My User View Shares
SharingApi listUserShares GET /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/share/ List User Shares
SharingApi listUserViewShares GET /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/user-view-shares/ List User View Shares
SharingApi updateGroupShare PUT /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/group-shares/{group_id}/ Update Group Share
SharingApi updateGroupViewShare PUT /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/group-view-shares/{group_view_share_id}/ Update Group View Share
SharingApi updateUserShare PUT /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/share/ Update User Share
SharingApi updateUserViewShare PUT /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/user-view-shares/{user_view_share_id}/ Update User View Share
SharingLinksApi createBaseExternalLink POST /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/external-links/ Create Base External Link
SharingLinksApi createInviteLink POST /api/v2.1/dtables/invite-links/ Create Invite Link
SharingLinksApi createViewExternalLink POST /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/view-external-links/ Create View External Link
SharingLinksApi deleteExternalLink DELETE /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/external-links/{external_link_token}/ Delete External Link
SharingLinksApi deleteInviteLink DELETE /api/v2.1/dtables/invite-links/{invite_link_token}/ Delete Invite Link
SharingLinksApi deleteViewExternalLink DELETE /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/view-external-links/{view_external_link_token}/ Delete View External Link
SharingLinksApi listBaseExternalLinks GET /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/external-links/ List Base External Links
SharingLinksApi listViewExternalLinks GET /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/view-external-links/ List View External Links
SnapshotsApi listSnapshots GET /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/snapshots/ List Snapshots
SnapshotsApi restoreSnapshot POST /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/snapshots/{commit_id}/restore/ Restore Snapshot
SystemNotificationsApi listSystemNotifications GET /api/v2.1/sys-user-notifications/unseen/ List System Notifications
SystemNotificationsApi markSystemNotificationsAsSeen PUT /api/v2.1/sys-user-notifications/{sys_notification_id}/seen/ Mark System Notification As Seen
UserApi addUserAvatar POST /api/v2.1/user-avatar/ Upload/Update User Avatar
UserApi getAccountInfo GET /api2/account/info/ Get Account Info
UserApi getPublicUserInfo GET /api/v2.1/user-common-info/{user_id}/ Get Public User Info
UserApi listPublicUserInfos POST /api/v2.1/user-list/ List Public User Infos
UserApi searchUser GET /api2/search-user/ Search User
UserApi updateEmailAddress PUT /api/v2.1/user/contact-email/ Update Email Address
WebhooksApi createWebhook POST /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/webhooks/ Create Webhook
WebhooksApi deleteWebhook DELETE /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/webhooks/{webhook_id}/ Delete Webhook
WebhooksApi listWebhooks GET /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/webhooks/ List Webhooks
WebhooksApi updateWebhook PUT /api/v2.1/workspace/{workspace_id}/dtable/{base_name}/webhooks/{webhook_id}/ Update Webhook