Copy selected table content

GET

table

{tableId}

selection

copy

curl --request GET \
  --url 'https://app.teable.io/api/table/%7BtableId%7D/selection/copy?viewId=viwXXXXXXX&ignoreViewQuery=SOME_STRING_VALUE&filterByTql=%7Bfield%7D+%3D+%27Completed%27+AND+%7Bfield%7D+%3E+5&filter=SOME_STRING_VALUE&search=SOME_ARRAY_VALUE&filterLinkCellCandidate=fldXXXXXXX&filterLinkCellCandidate=recXXXXXXX&filterLinkCellSelected=fldXXXXXXX&filterLinkCellSelected=recXXXXXXX&selectedRecordIds=SOME_ARRAY_VALUE&orderBy=SOME_STRING_VALUE&groupBy=SOME_STRING_VALUE&collapsedGroupIds=SOME_ARRAY_VALUE&projection=SOME_ARRAY_VALUE&ranges=%5B%5B0%2C+0%5D%2C+%5B1%2C+1%5D%5D&type=columns' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

{
  "content": "<string>",
  "header": [
    {
      "id": "<string>",
      "name": "Tags",
      "type": "singleSelect",
      "description": "this is a summary",
      "options": {
        "expression": "countall({values})",
        "timeZone": "<string>",
        "formatting": {
          "date": "<string>",
          "time": "HH:mm",
          "timeZone": "<string>"
        },
        "showAs": {
          "type": "url"
        }
      },
      "isLookup": true,
      "lookupOptions": {
        "foreignTableId": "<string>",
        "lookupFieldId": "<string>",
        "relationship": "oneOne",
        "fkHostTableName": "<string>",
        "selfKeyName": "<string>",
        "foreignKeyName": "<string>",
        "filter": {},
        "linkFieldId": "<string>"
      },
      "notNull": true,
      "unique": true,
      "isPrimary": true,
      "isComputed": true,
      "isPending": true,
      "hasError": true,
      "cellValueType": "string",
      "isMultipleCellValue": true,
      "dbFieldType": "TEXT",
      "dbFieldName": "<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

Query Parameters

viewId

string

Set the view you want to fetch, default is first view. result will filter and sort by view options.

ignoreViewQuery

When a viewId is specified, configure this to true will ignore the view's filter, sort, etc

filterByTql

string

deprecated

filter

string

A filter object used to filter results. It allows complex query conditions based on fields, operators, and values.

Search for records that match the specified field and value

filterLinkCellCandidate

Filter out the records that can be selected by a given link cell from the relational table. For example, if the specified field is one to many or one to one relationship, recordId for which the field has already been selected will not appear.

filterLinkCellSelected

Filter out selected records based on this link cell from the relational table. Note that viewId, filter, and orderBy will not take effect in this case because selected records has it own order. Ignoring recordId gets all the selected records for the field

selectedRecordIds

string[]

Filter selected records by record ids

orderBy

string

An array of sort objects that specifies how the records should be ordered.

groupBy

string

An array of group objects that specifies how the records should be grouped.

collapsedGroupIds

string[]

An array of group ids that specifies which groups are collapsed

projection

string[]

If you want to get only some fields, pass in this parameter, otherwise all visible fields will be obtained

ranges

string

required

The parameter "ranges" is used to represent the coordinates [column, row][] of a selected range in a table.

type

enum<string>

Types of non-contiguous selections

Available options:

rows,

columns

Response

200 - application/json

Copy content

content

string

required

header

object[]

required

header.id

string

required

The id of the field.

header.name

string

required

The name of the field. can not be duplicated in the table.

header.type

enum<string>

required

The field types supported by teable.

Available options:

singleLineText,

longText,

user,

attachment,

checkbox,

multipleSelect,

singleSelect,

date,

number,

duration,

rating,

formula,

rollup,

count,

link,

createdTime,

lastModifiedTime,

createdBy,

lastModifiedBy,

autoNumber,

button

header.options

object

required

The configuration options of the field. The structure of the field's options depend on the field's type.

header.cellValueType

enum<string>

required

The cell value type of the field.

Available options:

string,

number,

boolean,

dateTime

header.dbFieldType

enum<string>

required

The field type of database that cellValue really store.

Available options:

TEXT,

INTEGER,

DATETIME,

REAL,

BLOB,

JSON,

BOOLEAN

header.dbFieldName

string

required

Field(column) name in backend database. Limitation: 1-63 characters, can only contain letters, numbers and underscore, case sensitive, cannot be duplicated with existing db field name in the table.

Minimum length: 1

header.description

string

The description of the field.

header.isLookup

boolean

Whether this field is lookup field. witch means cellValue and [fieldType] is looked up from the linked table.

header.lookupOptions

object

field lookup options.

header.notNull

boolean

Whether this field is not null.

header.unique

boolean

Whether this field is not unique.

header.isPrimary

boolean

Whether this field is primary field.

header.isComputed

boolean

Whether this field is computed field, you can not modify cellValue in computed field.

header.isPending

boolean

Whether this field's calculation is pending.

header.hasError

boolean

Whether This field has a configuration error. Check the fields referenced by this field's formula or configuration.

header.isMultipleCellValue

boolean

Whether this field has multiple cell value.

Paste content into selected rangeApply paste operation to insert content into the selected table range

curl --request GET \
  --url 'https://app.teable.io/api/table/%7BtableId%7D/selection/copy?viewId=viwXXXXXXX&ignoreViewQuery=SOME_STRING_VALUE&filterByTql=%7Bfield%7D+%3D+%27Completed%27+AND+%7Bfield%7D+%3E+5&filter=SOME_STRING_VALUE&search=SOME_ARRAY_VALUE&filterLinkCellCandidate=fldXXXXXXX&filterLinkCellCandidate=recXXXXXXX&filterLinkCellSelected=fldXXXXXXX&filterLinkCellSelected=recXXXXXXX&selectedRecordIds=SOME_ARRAY_VALUE&orderBy=SOME_STRING_VALUE&groupBy=SOME_STRING_VALUE&collapsedGroupIds=SOME_ARRAY_VALUE&projection=SOME_ARRAY_VALUE&ranges=%5B%5B0%2C+0%5D%2C+%5B1%2C+1%5D%5D&type=columns' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

{
  "content": "<string>",
  "header": [
    {
      "id": "<string>",
      "name": "Tags",
      "type": "singleSelect",
      "description": "this is a summary",
      "options": {
        "expression": "countall({values})",
        "timeZone": "<string>",
        "formatting": {
          "date": "<string>",
          "time": "HH:mm",
          "timeZone": "<string>"
        },
        "showAs": {
          "type": "url"
        }
      },
      "isLookup": true,
      "lookupOptions": {
        "foreignTableId": "<string>",
        "lookupFieldId": "<string>",
        "relationship": "oneOne",
        "fkHostTableName": "<string>",
        "selfKeyName": "<string>",
        "foreignKeyName": "<string>",
        "filter": {},
        "linkFieldId": "<string>"
      },
      "notNull": true,
      "unique": true,
      "isPrimary": true,
      "isComputed": true,
      "isPending": true,
      "hasError": true,
      "cellValueType": "string",
      "isMultipleCellValue": true,
      "dbFieldType": "TEXT",
      "dbFieldName": "<string>"
    }
  ]
}

Quick Start

API List

Copy selected table content

Authorizations

Path Parameters

Query Parameters

Response