> ## 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 All Workbooks in workspace > ## 1️⃣ Overview **Purpose:** Retrieve a list of all Workbooks associated with a specific workspace. Used to populate workspace dashboards or fetch workbook structure metadata for synchronization tasks. --- ## 2️⃣ Endpoint ``` bash GET /noCo/api/v2/workspaces/{workspaceId}/tables ``` --- ## 3️⃣ Path Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | workspaceId | UUID | ✅ Yes | Identifier of the workspace to query | --- ## 4️⃣ Query Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | isIncludeColumns | boolean | ❌ No | If `true`, the response includes column metadata for each workbook | --- ## 5️⃣ Authentication Requires authentication using: ``` bash Authorization: Bearer ``` --- ## 6️⃣ Request Headers | Header | Required | | --- | --- | | Authorization | ✅ Yes | | Accept | ❌ No | --- ## 7️⃣ Example Request ``` bash curl -X GET https://be.datagol.ai/noCo/api/v2/workspaces/{workspaceId}/tables?isIncludeColumns=true \ -H "Authorization: Bearer " ``` --- ## 8️⃣ Response Fields | Field | Type | Description | | --- | --- | --- | | id | string | Unique identifier for the workbook | | title | string | Display name of the workbook | | columns | array | Column metadata (returned only when `isIncludeColumns=true`) | | tableType | enum | Type of workbook (`DYNAMIC`, `STATIC`) | --- ## 9️⃣ Behavior Summary ``` Retrieves all workbooks within the specified workspace. If isIncludeColumns=true, column definitions such as name, type, and UI metadata are included in the response. Results are typically returned in the order of workbook position configured in the workspace. ``` ## OpenAPI ````yaml /openapi/openapi.yaml get /noCo/api/v2/workspaces/{workspaceId}/tables 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: parameters: - name: workspaceId in: path required: true schema: type: string example: '{{workspaceId}}' get: tags: - WorkBook summary: Get All Workbooks in workspace description: >- ## 1️⃣ Overview **Purpose:** Retrieve a list of all Workbooks associated with a specific workspace. Used to populate workspace dashboards or fetch workbook structure metadata for synchronization tasks. --- ## 2️⃣ Endpoint ``` bash GET /noCo/api/v2/workspaces/{workspaceId}/tables ``` --- ## 3️⃣ Path Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | workspaceId | UUID | ✅ Yes | Identifier of the workspace to query | --- ## 4️⃣ Query Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | isIncludeColumns | boolean | ❌ No | If `true`, the response includes column metadata for each workbook | --- ## 5️⃣ Authentication Requires authentication using: ``` bash Authorization: Bearer ``` --- ## 6️⃣ Request Headers | Header | Required | | --- | --- | | Authorization | ✅ Yes | | Accept | ❌ No | --- ## 7️⃣ Example Request ``` bash curl -X GET https://be.datagol.ai/noCo/api/v2/workspaces/{workspaceId}/tables?isIncludeColumns=true \ -H "Authorization: Bearer " ``` --- ## 8️⃣ Response Fields | Field | Type | Description | | --- | --- | --- | | id | string | Unique identifier for the workbook | | title | string | Display name of the workbook | | columns | array | Column metadata (returned only when `isIncludeColumns=true`) | | tableType | enum | Type of workbook (`DYNAMIC`, `STATIC`) | --- ## 9️⃣ Behavior Summary ``` Retrieves all workbooks within the specified workspace. If isIncludeColumns=true, column definitions such as name, type, and UI metadata are included in the response. Results are typically returned in the order of workbook position configured in the workspace. ``` parameters: - name: isIncludeColumns in: query schema: type: boolean example: 'true' responses: '200': description: Get tables in workspace security: - bearerAuth: [] components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: | This API uses OAuth 2.0 with the authorization code grant flow. ````