Skip to main content

Get Embedded Links


The Embedded Links are only available for the spaces on the paid Pro or higher plan in AITable Cloud as well as Enterprise self-hosted edition.

Node types that support creating embedded links are:


Here is an example of calling API to check and get all the embedded links of a datasheet.

If you'd like to get all embedded links about a specified datasheet in the space, you can follow below steps:

  1. Obtain your API token. (how to)

  2. Obtain the spaceId. (how to)

  3. Obtain the datasheetId. (how to)

  4. Open your system terminal, copy and paste the following code on it and make a request to AITable server (here the example space ID is spcjXzqVrjaP3, and the datasheetId is dstWUHwzTHd2YQaXEE)

    curl -X GET \
    "" \
    -H "Authorization: Bearer {Your API Token}" \
    -H "Content-Type: application/json"
  5. The server will return the following JSON object, and the information of the embedded link will be displayed in data property:

    "code": 200,
    "success": true,
    "data": [{
    "linkId": "embb90a52cfc02a4f83",
    "url": "",
    "payload": {
    "primarySideBar": {
    "collapsed": false
    "viewControl": {
    "tabBar": false,
    "toolBar": {
    "basicTools": false,
    "widgetBtn": false,
    "apiBtn": false,
    "formBtn": false,
    "historyBtn": false,
    "robotBtn": false,
    "addWidgetBtn": false,
    "fullScreenBtn": false,
    "formSettingBtn": false
    "collapsed": false,
    "collaboratorStatusBar": true,
    "nodeInfoBar": false
    "bannerLogo": true,
    "permissionType": "readOnly"
    "theme": "light"
    "message": "SUCCESS"

    For the meaning of each parameter in the response result above, please check the API Reference.