POST
/
import
/
{baseId}
curl --request POST \
  --url https://app.teable.io/api/import/%7BbaseId%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"worksheets":{"property1":{"name":"string","columns":[{"type":"singleLineText","name":"string","sourceColumnIndex":0}],"useFirstRowAsHeader":true,"importData":true},"property2":{"name":"string","columns":[{"type":"singleLineText","name":"string","sourceColumnIndex":0}],"useFirstRowAsHeader":true,"importData":true}},"attachmentUrl":"http://example.com","fileType":"csv","notification":true,"tz":"string"}'
{
  "id": "<string>",
  "name": "<string>",
  "dbTableName": "<string>",
  "description": "<string>",
  "icon": "<string>",
  "order": 123,
  "lastModifiedTime": "<string>",
  "defaultViewId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
baseId
string
required

Body

application/json
​
worksheets
object
required
​
attachmentUrl
string
required
​
fileType
enum<string>
required
Available options:
csv,
excel
​
tz
string
required

The time zone that should be used to format dates

​
notification
boolean

Response

201 - application/json
Returns data about a table without records
​
id
string
required

The id of table.

​
name
string
required

The name of the table.

​
dbTableName
string
required

Table name in backend database. Limitation: 1-63 characters, start with letter, can only contain letters, numbers and underscore, case insensitive, cannot be duplicated with existing db table name in the base.

​
description
string

The description of the table.

​
icon
string

The emoji icon string of the table.

​
order
number
​
lastModifiedTime
string

The last modified time of the table.

​
defaultViewId
string

The default view id of the table.

Previous
Patch import
Next