Post table view duplicate

POST

table

{tableId}

view

{viewId}

duplicate

cURL

curl --request POST \
  --url https://app.teable.ai/api/table/%7BtableId%7D/view/%7BviewId%7D/duplicate \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"name":"string","type":"grid","description":"string","order":0,"options":{"rowHeight":"short","fieldNameDisplayLines":1,"frozenColumnCount":0,"frozenFieldId":"string"},"sort":{"sortObjs":[{"fieldId":"string","order":"asc"}],"manualSort":true},"filter":{},"group":[{"fieldId":"string","order":"asc"}],"isLocked":true,"shareId":"string","enableShare":true,"shareMeta":{"allowCopy":true,"includeHiddenField":true,"password":"string","includeRecords":true,"submit":{"allow":true,"requireLogin":true}},"columnMeta":{"property1":{"order":0,"width":0,"hidden":true,"statisticFunc":"count"},"property2":{"order":0,"width":0,"hidden":true,"statisticFunc":"count"}}}'

{
  "id": "<string>",
  "name": "<string>",
  "type": "grid",
  "createdBy": "<string>",
  "createdTime": "<string>",
  "columnMeta": {},
  "description": "<string>",
  "order": 123,
  "options": {
    "rowHeight": "short",
    "fieldNameDisplayLines": 2,
    "frozenColumnCount": 1,
    "frozenFieldId": "<string>"
  },
  "sort": {
    "sortObjs": [
      {
        "fieldId": "<string>",
        "order": "asc"
      }
    ],
    "manualSort": true
  },
  "filter": {},
  "group": [
    {
      "fieldId": "<string>",
      "order": "asc"
    }
  ],
  "isLocked": true,
  "shareId": "<string>",
  "enableShare": true,
  "shareMeta": {
    "allowCopy": true,
    "includeHiddenField": true,
    "password": "<string>",
    "includeRecords": true,
    "submit": {
      "allow": true,
      "requireLogin": true
    }
  },
  "lastModifiedBy": "<string>",
  "lastModifiedTime": "<string>",
  "pluginId": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

tableId

string

required

viewId

string

required

Body

application/json

type

enum<string>

required

Available options:

grid,

calendar,

kanban,

form,

gallery,

plugin

name

string

description

string

order

number

options

object

Option 1
Option 2
Option 3
Option 4
Option 5
Option 6

Show child attributes

options.rowHeight

enum<string>

The row height level of row in view

Available options:

short,

medium,

tall,

extraTall,

autoFit

options.fieldNameDisplayLines

number

The field name display lines in view

Required range: 1 <= x <= 3

options.frozenColumnCount

number

The frozen column count in view. Deprecated: this field will be removed in a future release and may no longer take effect.

Required range: x >= 0

options.frozenFieldId

string

Freeze to the right side of this field id in grid view

sort

object

Show child attributes

sort.sortObjs

object[]

required

Show child attributes

sort.sortObjs.fieldId

string

required

The id of the field.

sort.sortObjs.order

enum<string>

required

Available options:

asc,

desc

sort.manualSort

boolean

filter

object

A filter object for complex query conditions based on fields, operators, and values. Use our visual query builder at https://app.teable.ai/developer/tool/query-builder to build filters.

group

object[] | null

Show child attributes

group.fieldId

string

required

The id of the field.

group.order

enum<string>

required

Available options:

asc,

desc

isLocked

boolean

Show child attributes

Minimum string length: 3

Show child attributes

columnMeta

object

A mapping of view IDs to their corresponding column metadata.

Show child attributes

columnMeta.{key}

object

Option 1
Option 2
Option 3
Option 4
Option 5

Show child attributes

columnMeta.{key}.order

number

required

Order is a floating number, column will sort by it in the view.

columnMeta.{key}.width

number

Column width in the view.

columnMeta.{key}.hidden

boolean

If column hidden in the view.

columnMeta.{key}.statisticFunc

enum<string> | null

Statistic function of the column in the view.

Available options:

count,

empty,

filled,

unique,

max,

min,

sum,

average,

checked,

unChecked,

percentEmpty,

percentFilled,

percentUnique,

percentChecked,

percentUnChecked,

earliestDate,

latestDate,

dateRangeOfDays,

dateRangeOfMonths,

totalAttachmentSize

Response

201 - application/json

Returns data about a view.

string

required

name

string

required

type

enum<string>

required

Available options:

grid,

calendar,

kanban,

form,

gallery,

plugin

createdBy

string

required

createdTime

string

required

columnMeta

object

required

A mapping of view IDs to their corresponding column metadata.

Show child attributes

columnMeta.{key}

object

Option 1
Option 2
Option 3
Option 4
Option 5

Show child attributes

columnMeta.{key}.order

number

required

Order is a floating number, column will sort by it in the view.

columnMeta.{key}.width

number

Column width in the view.

columnMeta.{key}.hidden

boolean

If column hidden in the view.

columnMeta.{key}.statisticFunc

enum<string> | null

Statistic function of the column in the view.

Available options:

count,

empty,

filled,

unique,

max,

min,

sum,

average,

checked,

unChecked,

percentEmpty,

percentFilled,

percentUnique,

percentChecked,

percentUnChecked,

earliestDate,

latestDate,

dateRangeOfDays,

dateRangeOfMonths,

totalAttachmentSize

description

string

order

number

options

object

Option 1
Option 2
Option 3
Option 4
Option 5
Option 6

Show child attributes

options.rowHeight

enum<string>

The row height level of row in view

Available options:

short,

medium,

tall,

extraTall,

autoFit

options.fieldNameDisplayLines

number

The field name display lines in view

Required range: 1 <= x <= 3

options.frozenColumnCount

number

The frozen column count in view. Deprecated: this field will be removed in a future release and may no longer take effect.

Required range: x >= 0

options.frozenFieldId

string

Freeze to the right side of this field id in grid view

sort

object

Show child attributes

sort.sortObjs

object[]

required

Show child attributes

sort.sortObjs.fieldId

string

required

The id of the field.

sort.sortObjs.order

enum<string>

required

Available options:

asc,

desc

sort.manualSort

boolean

filter

object

A filter object for complex query conditions based on fields, operators, and values. Use our visual query builder at https://app.teable.ai/developer/tool/query-builder to build filters.

group

object[] | null

Show child attributes

group.fieldId

string

required

The id of the field.

group.order

enum<string>

required

Available options:

asc,

desc

isLocked

boolean

Show child attributes

Minimum string length: 3

Show child attributes

lastModifiedBy

string

lastModifiedTime

string

pluginId

string

Get base collaborator user listGet base collaborator user list

⌘I

cURL

curl --request POST \
  --url https://app.teable.ai/api/table/%7BtableId%7D/view/%7BviewId%7D/duplicate \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"name":"string","type":"grid","description":"string","order":0,"options":{"rowHeight":"short","fieldNameDisplayLines":1,"frozenColumnCount":0,"frozenFieldId":"string"},"sort":{"sortObjs":[{"fieldId":"string","order":"asc"}],"manualSort":true},"filter":{},"group":[{"fieldId":"string","order":"asc"}],"isLocked":true,"shareId":"string","enableShare":true,"shareMeta":{"allowCopy":true,"includeHiddenField":true,"password":"string","includeRecords":true,"submit":{"allow":true,"requireLogin":true}},"columnMeta":{"property1":{"order":0,"width":0,"hidden":true,"statisticFunc":"count"},"property2":{"order":0,"width":0,"hidden":true,"statisticFunc":"count"}}}'

{
  "id": "<string>",
  "name": "<string>",
  "type": "grid",
  "createdBy": "<string>",
  "createdTime": "<string>",
  "columnMeta": {},
  "description": "<string>",
  "order": 123,
  "options": {
    "rowHeight": "short",
    "fieldNameDisplayLines": 2,
    "frozenColumnCount": 1,
    "frozenFieldId": "<string>"
  },
  "sort": {
    "sortObjs": [
      {
        "fieldId": "<string>",
        "order": "asc"
      }
    ],
    "manualSort": true
  },
  "filter": {},
  "group": [
    {
      "fieldId": "<string>",
      "order": "asc"
    }
  ],
  "isLocked": true,
  "shareId": "<string>",
  "enableShare": true,
  "shareMeta": {
    "allowCopy": true,
    "includeHiddenField": true,
    "password": "<string>",
    "includeRecords": true,
    "submit": {
      "allow": true,
      "requireLogin": true
    }
  },
  "lastModifiedBy": "<string>",
  "lastModifiedTime": "<string>",
  "pluginId": "<string>"
}

Quick Start

API List

Post table view duplicate

Authorizations

Path Parameters

Body

Response