> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.datagol.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Link Data

> ## 1️⃣ Overview

**Purpose:**
Retrieves the linked records for a specific row via a LINK column. Given a source record's row ID, this returns all destination records that are linked to it through the specified link column.

---

## 2️⃣ Endpoint

```
GET /noCo/api/v2/workspaces/{workspaceId}/tables/{tableId}/{linkColumnId}/linkData?id={rowId}
```

---

## 3️⃣ Path Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| workspaceId | UUID | ✅ Yes | Workspace identifier |
| tableId | UUID | ✅ Yes | Source table identifier |
| linkColumnId | UUID | ✅ Yes | ID of the LINK column to fetch linked data for |

---

## 4️⃣ Query Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| id | integer | ✅ Yes | The row ID of the source record whose linked records you want to retrieve |

---

## 5️⃣ Authentication

Requires **Bearer JWT Token**

```
Authorization: Bearer <token>
```

---

## 6️⃣ Request Headers

| Header | Required |
| --- | --- |
| Authorization | ✅ Yes |
| Content-Type: application/json | ✅ Yes |

---

## 7️⃣ Example Request

```bash
curl -X GET 'https://be.datagol.ai/noCo/api/v2/workspaces/{workspaceId}/tables/{tableId}/{linkColumnId}/linkData?id=1' \
-H "Authorization: Bearer <token>"
```

---

## 8️⃣ Behavior Summary

```
Returns all records linked to the specified source row via the given LINK column.
Supports:
• Fetching linked records for any LINK column type (HAS_MANY, ONE_TO_ONE, MANY_TO_MANY)
• id query param — row ID of the source record in the current table
• linkColumnId — identifies which link column's data to retrieve
```



## OpenAPI

````yaml /openapi/openapi.yaml get /noCo/api/v2/workspaces/{workspaceId}/tables/{tableId}/{linkColumnId}/linkData
openapi: 3.0.0
info:
  title: DataGOL APIs
  version: 1.0.0
  description: ''
servers:
  - url: https://be.datagol.ai
  - url: https://be.datagol.ai
  - url: https://kg.datagol.ai
  - url: https://ai.datagol.ai
security: []
tags:
  - name: Links & Joins
    description: >
      ## 🔗 Links & Joins


      LINK and LOOKUP are special workbook column types that enable relational
      data modeling across tables.


      | Column Type | Purpose |

      |---|---|

      | `LINK` | Defines a relationship between two tables |

      | `LOOKUP` | Projects columns from an associated table via a link |


      Both are configured through `ColumnDTO.colOptions`. A table can have
      multiple link columns, and each link can have multiple lookup columns.


      ---


      ## 📐 UI Data Types


      - **LINK** — Special column used to represent inter-table relations

      - **LOOKUP** — Special column used to project associated table fields via
      a link


      ---


      ## 🔗 LINK Semantics


      A LINK column stores metadata for:

      - `tableId` — Current table

      - `associatedTableId` — Associated (linked) table

      - `relationType` — Type of relationship

      - `linkColumnId` — Link column identifier


      **Supported relation patterns:**


      | Pattern | Description |

      |---|---|

      | `ONE_TO_ONE` | Each record in the source maps to one record in the
      destination |

      | `ONE_TO_MANY` | One source record maps to many destination records |

      | `MANY_TO_MANY` | Many source records map to many destination records |


      ---


      ## 🔍 LOOKUP Semantics


      - A LOOKUP column is tightly coupled with a specific LINK column

      - References a link using `linkColumnId`

      - Represents a selected column from the associated table

      - Multiple lookup columns can be defined for the same link


      ---


      ## 🗂️ Metadata in `ColumnDTO.colOptions`


      Use `colOptions` to persist link/lookup metadata.


      | Field | Description |

      |---|---|

      | `columnId` | Current column ID |

      | `tableId` | Current table ID |

      | `associatedTableId` | Associated table ID |

      | `linkColumnId` | Link column ID — used by LOOKUP; references the LINK
      column's `columnId` |

      | `relationType` | Relation semantics for LINK |


      ---


      ## 🔄 Manual Linking Record Flow


      To create manual record-level links:


      1. Fetch associated table schema/data

      2. User selects associated record(s) to link

      3. Send linking payload with:
          - `sourceRecordId` — PK of the current table row
          - `destinationRecordId` — PK of the associated table row
          - `linkColumnId` — LINK column identifier
      4. Backend resolves link metadata from `linkColumnId` (relation type,
      associated table, direction/constraints)

      5. Backend applies relation rules and stores the link relation


      ---


      ## 📋 Record Linking Contract


      | Field | Description |

      |---|---|

      | `sourceRecordId` | PK of the current table row |

      | `destinationRecordId` | PK of the associated table row |

      | `linkColumnId` | LINK column identifier |

      | `tableId` | Current table ID |


      > Backend derives all remaining relation metadata from the link
      configuration.


      ---


      ## ⚠️ Important Notes


      > - LINK and LOOKUP are **column-level constructs** first; record linking
      is a data-level operation built on top

      > - LOOKUP behavior depends on LINK existence and metadata integrity

      > - With multiple links to the same associated table, each LOOKUP must
      bind to the correct `linkColumnId`

      > - Always treat the associated row ID as the associated table PK for
      linking UI selection
paths:
  /noCo/api/v2/workspaces/{workspaceId}/tables/{tableId}/{linkColumnId}/linkData:
    get:
      tags:
        - Links & Joins
      summary: Get Link Data
      description: >-
        ## 1️⃣ Overview


        **Purpose:**

        Retrieves the linked records for a specific row via a LINK column. Given
        a source record's row ID, this returns all destination records that are
        linked to it through the specified link column.


        ---


        ## 2️⃣ Endpoint


        ```

        GET
        /noCo/api/v2/workspaces/{workspaceId}/tables/{tableId}/{linkColumnId}/linkData?id={rowId}

        ```


        ---


        ## 3️⃣ Path Parameters


        | Parameter | Type | Required | Description |

        | --- | --- | --- | --- |

        | workspaceId | UUID | ✅ Yes | Workspace identifier |

        | tableId | UUID | ✅ Yes | Source table identifier |

        | linkColumnId | UUID | ✅ Yes | ID of the LINK column to fetch linked
        data for |


        ---


        ## 4️⃣ Query Parameters


        | Parameter | Type | Required | Description |

        | --- | --- | --- | --- |

        | id | integer | ✅ Yes | The row ID of the source record whose linked
        records you want to retrieve |


        ---


        ## 5️⃣ Authentication


        Requires **Bearer JWT Token**


        ```

        Authorization: Bearer <token>

        ```


        ---


        ## 6️⃣ Request Headers


        | Header | Required |

        | --- | --- |

        | Authorization | ✅ Yes |

        | Content-Type: application/json | ✅ Yes |


        ---


        ## 7️⃣ Example Request


        ```bash

        curl -X GET
        'https://be.datagol.ai/noCo/api/v2/workspaces/{workspaceId}/tables/{tableId}/{linkColumnId}/linkData?id=1'
        \

        -H "Authorization: Bearer <token>"

        ```


        ---


        ## 8️⃣ Behavior Summary


        ```

        Returns all records linked to the specified source row via the given
        LINK column.

        Supports:

        • Fetching linked records for any LINK column type (HAS_MANY,
        ONE_TO_ONE, MANY_TO_MANY)

        • id query param — row ID of the source record in the current table

        • linkColumnId — identifies which link column's data to retrieve

        ```
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Workspace identifier
        - name: tableId
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Source table identifier
        - name: linkColumnId
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: ID of the LINK column to fetch linked data for
        - name: id
          in: query
          required: true
          schema:
            type: integer
          description: >-
            The row ID of the source record whose linked records you want to
            retrieve
      responses:
        '200':
          description: Linked records retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                      description: Row ID of the linked record in the destination table
                    cellValues:
                      type: object
                      description: >-
                        Map of column names to their values for the linked
                        record
                      properties:
                        column1:
                          type: number
                          description: User-defined column value
                        column2:
                          type: string
                          description: User-defined column value
                        column3:
                          type: number
                          description: User-defined column value
                        column4:
                          type: integer
                          description: User-defined column value
              example:
                - id: 2
                  cellValues:
                    course_id: 102
                    course_name: JAVA
                    st_id: 3
                    employee_075d: 2
                    employee_753d: 4
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: |
        This API uses OAuth 2.0 with the authorization code grant flow.

````