Quick Start
API List
- record
- space
- base
- view
- API Reference
- dashboard
- plugin
- attachments
- admin
- trash
- field
- aggregation
- table
- selection
- plan
- user
- auth
- db-connection
- invitation
- share
- POSTPost share viewauth
- GETGet share view
- GETGet share viewaggregations
- GETGet share viewrow count
- POSTPost share viewform submit
- GETGet share viewcopy
- GETGet share viewgroup points
- GETGet share viewlink records
- GETGet share viewcollaborators
- GETGet share viewsearch count
- GETGet share viewsearch index
- GETGet share viewcalendar daily collection
- POST
- notification
- access-token
- import
- export
- pin
- billing
- usage
- oauth
- comment
- organization
- ai
- integrity
- plugin-panel
- plugin-context-menu
- template
- automation
- authority-matrix
- enterprise
- space-manage
share
Get share view
share
Get share view
get share view info
GET
/
share
/
{shareId}
/
view
curl --request GET \
--url https://app.teable.cn/api/share/%7BshareId%7D/view \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{
"viewId": "<string>",
"tableId": "<string>",
"shareId": "<string>",
"shareMeta": {
"allowCopy": true,
"includeHiddenField": true,
"password": "<string>",
"includeRecords": true,
"submit": {
"allow": true,
"requireLogin": true
}
},
"view": {
"id": "<string>",
"name": "<string>",
"type": "grid",
"description": "<string>",
"order": 123,
"options": {
"rowHeight": "short",
"fieldNameDisplayLines": 2,
"frozenColumnCount": 1
},
"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
}
},
"createdBy": "<string>",
"lastModifiedBy": "<string>",
"createdTime": "<string>",
"lastModifiedTime": "<string>",
"columnMeta": {},
"pluginId": "<string>"
},
"fields": [
{
"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"
}
},
"aiConfig": {
"modelKey": "<string>",
"isAutoFill": true,
"attachPrompt": "<string>",
"type": "extraction",
"sourceFieldId": "<string>"
},
"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>",
"recordRead": true,
"recordCreate": true
}
],
"records": [
{
"id": "<string>",
"name": "<string>",
"fields": {},
"autoNumber": 123,
"createdTime": "<string>",
"lastModifiedTime": "<string>",
"createdBy": "<string>",
"lastModifiedBy": "<string>",
"permissions": {},
"undeletable": true
}
],
"extra": {
"groupPoints": [
{
"id": "<string>",
"type": 0,
"depth": 1,
"value": "<any>",
"isCollapsed": true
}
],
"plugin": {
"pluginId": "<string>",
"pluginInstallId": "<string>",
"name": "<string>",
"url": "<string>",
"storage": {}
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Response
200 - application/json
share view info
The response is of type object
.
curl --request GET \
--url https://app.teable.cn/api/share/%7BshareId%7D/view \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{
"viewId": "<string>",
"tableId": "<string>",
"shareId": "<string>",
"shareMeta": {
"allowCopy": true,
"includeHiddenField": true,
"password": "<string>",
"includeRecords": true,
"submit": {
"allow": true,
"requireLogin": true
}
},
"view": {
"id": "<string>",
"name": "<string>",
"type": "grid",
"description": "<string>",
"order": 123,
"options": {
"rowHeight": "short",
"fieldNameDisplayLines": 2,
"frozenColumnCount": 1
},
"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
}
},
"createdBy": "<string>",
"lastModifiedBy": "<string>",
"createdTime": "<string>",
"lastModifiedTime": "<string>",
"columnMeta": {},
"pluginId": "<string>"
},
"fields": [
{
"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"
}
},
"aiConfig": {
"modelKey": "<string>",
"isAutoFill": true,
"attachPrompt": "<string>",
"type": "extraction",
"sourceFieldId": "<string>"
},
"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>",
"recordRead": true,
"recordCreate": true
}
],
"records": [
{
"id": "<string>",
"name": "<string>",
"fields": {},
"autoNumber": 123,
"createdTime": "<string>",
"lastModifiedTime": "<string>",
"createdBy": "<string>",
"lastModifiedBy": "<string>",
"permissions": {},
"undeletable": true
}
],
"extra": {
"groupPoints": [
{
"id": "<string>",
"type": 0,
"depth": 1,
"value": "<any>",
"isCollapsed": true
}
],
"plugin": {
"pluginId": "<string>",
"pluginInstallId": "<string>",
"name": "<string>",
"url": "<string>",
"storage": {}
}
}
}