Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Get the erd of a base
curl --request GET \
--url https://app.teable.ai/api/base/%7BbaseId%7D/erd \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{
"baseId": "<string>",
"nodes": [
{
"id": "<string>",
"name": "<string>",
"icon": "<string>",
"crossBaseId": "<string>",
"crossBaseName": "<string>",
"fields": [
{
"id": "<string>",
"name": "Tags",
"type": "singleSelect",
"isLookup": true,
"isPrimary": true
}
]
}
],
"edges": [
{
"source": {
"tableId": "<string>",
"tableName": "<string>",
"fieldId": "<string>",
"fieldName": "<string>"
},
"target": {
"tableId": "<string>",
"tableName": "<string>",
"fieldId": "<string>",
"fieldName": "<string>"
},
"relationship": "oneOne",
"isOneWay": true,
"type": "singleLineText"
}
]
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
curl --request GET \
--url https://app.teable.ai/api/base/%7BbaseId%7D/erd \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{
"baseId": "<string>",
"nodes": [
{
"id": "<string>",
"name": "<string>",
"icon": "<string>",
"crossBaseId": "<string>",
"crossBaseName": "<string>",
"fields": [
{
"id": "<string>",
"name": "Tags",
"type": "singleSelect",
"isLookup": true,
"isPrimary": true
}
]
}
],
"edges": [
{
"source": {
"tableId": "<string>",
"tableName": "<string>",
"fieldId": "<string>",
"fieldName": "<string>"
},
"target": {
"tableId": "<string>",
"tableName": "<string>",
"fieldId": "<string>",
"fieldName": "<string>"
},
"relationship": "oneOne",
"isOneWay": true,
"type": "singleLineText"
}
]
}