Get All Workbooks in workspace
WorkBook
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
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:
Authorization: Bearer <token>
6️⃣ Request Headers
| Header | Required |
|---|---|
| Authorization | ✅ Yes |
| Accept | ❌ No |
7️⃣ Example Request
curl -X GET https://be.datagol.ai/noCo/api/v2/workspaces/{workspaceId}/tables?isIncludeColumns=true \
-H "Authorization: Bearer <token>"
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.
GET
Get All Workbooks in workspace