APITable API Introduction

The API (Application Programming Interface, Application Interface) is a communication interface created to relay data between software.

APITable official provides various API interfaces that allow users to fetch data from APITable in the form of HTTPS requests, or push data to APITable.

What can you do with APITable's API

Connect APITable to other software, achieve mutual data transfer and build efficient workflows

• Connect to robot: to bring to groups when datasheet change
• Connect the iOS App "Shortcuts": to quickly write a record from your phone to APITable
• Connect browser plugin：implements bulk upload of images from Excel to APITable
• ……

As a backend database, help build product prototype quickly and validate ideas

APITable can easily store up to 10,000 lines of data that you can view as a lightweight NoSQL database without a SQL command, easily read and write data using the APITable's API.

• Developing a Zelda Menu that can easily read menu data from APITable
• Developing a lightweight course forum website to easily read discussion data from APITable
• Developing a simple note app to store notes data easily into APITable
• ……

Open APIs

Currently APITable open 6 types of API interfaces：records, fields, views, attachments, spaces, and work directories.

Record

Interface Type	Interface Role
Get Record	Gets records in the specified datasheet
Create Record	Create one or more lines of record in the specified datasheet
Update Record	Update one or more lines of record in the specified datasheet
Delete Record	Delete one or more lines in the specified datasheet

Field

Interface Type	Interface Role
Get Field	Gets information about all fields that have permission to view in the specified datasheet
Create Field	Create a field in the specified datasheet
Delete Field	Remove a field in the specified datasheet

View

Interface Type	Interface Role
Get View	Gets all views in the specified datasheet

Table

Interface Type	Interface Role
Create Table	Create a datasheet in the specified space

Attachment

Interface Type	Interface Role
Upload Attachment	Upload attachments to the specified datasheet

Space

Interface Type	Interface Role
Get a list of stations	Gets all Stations created or invited by current users

Work Directory

Interface Type	Interface Role
Get a list of files	Get the list of the most outer files in the work directory
Get File Details	Gets details of the specified files in the work directory. Type of files includes datasheet folders, collection tables, dashboards.

Common Parameters

The base URL of the APITable API request is https://api.apitable.com/fusion/v1/.

Note that：must use https, and cannot use an HTML request.

Some of the commonly used parameters when calling an interface are listed below and how to get the corresponding parameter value.

spaceId

A single user may create or be invited to multiple stations and each station has a Space ID (i.e. spaceId).

You can get spaceId by either way：

1. Sign in to APITable, click on the personal avatar in the lower left corner and copy the Space ID.

2. Sign in to APITable, enter the station's driver's class, copy the Space ID.

3. Call to get the Space Station list API interface to get the required spaceId.

nodeId

Each station has a work directory that has many file node.

Each node has an ID (i.e. nodeId).File node type includes:File node type includes:

• Datasheet: its nodeId equivalent to datasheetId is a string beginning with dst , e.g. dstZsEg3RpBvsdCgoop.
• Folder：its nodeId is a string starting with fod , e.g. fod23ha5NvyM5.
• Form：its nodeId is a string starting with Fom , e.g. fom68eghkCem0wZxk.
• Dashboard：its nodeId is a string starting with dsb such as dsbWxTei5gdTvdAfKM.

The way to get nodeId is simple：

Open any file node (datasheet, folder, form or dashboard) and find a string starting with dst,fod,fom or dsb this is the nodeId of the file.

datasheetId

Each datasheet has a corresponding apitableID (i. e. datasheetId).Each datasheet has a corresponding apitableID (i.e. datasheetId).A dataheetId must be specified when calling the API to add and delete datasheet.

Simple way to get dataheetId:

Open any datasheet and find a string starting with dst in the URL address bar. This is the datasheetId of this datasheet.

dashboardId

Each dashboard has a corresponding dashboard ID (that is, dashboardId).

The way to get dashboardId is very simple:

Open any dashboard and find a string starting with dsb in the URL address bar. This is the dashboardId of this dashboard.

viewId

Multiple views may be created in a datasheet.Each view has a view ID (i. e. viewId).Each view has a view ID (i. e. viewId).

The way to get viewId is simple：

Open any datasheet and find a string starting with viw in the URL address bar. This is the viewId of this datasheet.

recordId

A wiki table consists of several lines of records, each of which has a corresponding record ID (i. e. recordId).

You can get recordId by either way：

1. Open any datasheet, expand a line of record to fetch recordId and find a string starting with "rec" in the URL address bar. This is the record Id for this line.

2. You can call Get Record API interface to get the required recordId.

fieldId

A datasheet consists of several columns, each of which corresponds to one field.A datasheet consists of several columns, each of which corresponds to one field.Each field has a field ID (i. e. fieldId).

You can get fieldId by either way：

1. Open any datasheet to confirm that the current view contains fields that want to fetch the fieldId and then open the API example panel by clicking the "API" in the upper right corner. All fields of the current view can be found under "Fields".

2. You can call Get Field API interface to get the required fieldId.