Skip to main content
GET
/
noCo
/
api
/
v2
/
workspaces
/
search
Search Workspaces and Workbooks
curl --request GET \
  --url https://be.datagol.ai/noCo/api/v2/workspaces/search \
  --header 'x-auth-token: <api-key>'
[
  {
    "type": "TABLE",
    "isFolder": false,
    "id": "ec345675-06bf-4133-b8c3-f8fc1934b839",
    "name": "dg_order_item.csv",
    "description": "",
    "workspaceId": "055b4db3-96e1-45e1-8ff5-3a911b779a53",
    "workspaceName": "Link_v2",
    "workspaceCreatedBy": 371,
    "tableCreatedBy": 371,
    "uiMetadata": {
      "dataProvider": "JDBC"
    }
  },
  {
    "type": "TABLE",
    "isFolder": false,
    "id": "ca45078d-ed26-4752-a7a7-4aed24af033c",
    "name": "dg_Order.csv",
    "description": "",
    "workspaceId": "055b4db3-96e1-45e1-8ff5-3a911b779a53",
    "workspaceName": "Link_v2",
    "workspaceCreatedBy": 371,
    "tableCreatedBy": 371,
    "uiMetadata": {
      "dataProvider": "JDBC"
    }
  },
  {
    "type": "TABLE",
    "isFolder": false,
    "id": "bb3f3d22-bdef-45ec-8723-08f874e42247",
    "name": "Airbnb - SNOWFLAKE",
    "description": "",
    "workspaceId": "c50161cf-14dd-42a5-9b62-f8b6d89b48e9",
    "workspaceName": "BI Sanity (Bi team only)",
    "workspaceCreatedBy": 280,
    "tableCreatedBy": 41,
    "uiMetadata": {
      "dataProvider": "SNOWFLAKE"
    }
  }
]

Authorizations

​
x-auth-token
string
header
required

For server-to-server or automated access, use a DataGOL Service Account key. Pass it via the x-auth-token header instead of Authorization: x-auth-token: <service-account-key>

Query Parameters

​
query
string
default:""

Optional free-text filter. Matches against workbook and workspace names. Pass an empty string (or omit) to return all workbooks.

​
type
enum<string>
required

Resource type to search for. Must be TABLE to retrieve workbooks.

Available options:
TABLE

Response

Flat array of workbook items. Group by workspaceId to build the workspace → workbook hierarchy.

​
type
enum<string>

Always TABLE for workbook entries.

Available options:
TABLE
Example:

"TABLE"

​
isFolder
boolean

Always false for workbook entries. Folder entries are not returned.

Example:

false

​
id
string<uuid>

UUID of the workbook. Use this as the connector id in WORKBOOK_RAG objects.

Example:

"ec345675-06bf-4133-b8c3-f8fc1934b839"

​
name
string

Display name of the workbook.

Example:

"dg_order_item.csv"

​
description
string | null

Optional description of the workbook content.

Example:

""

​
workspaceId
string<uuid>

UUID of the workspace this workbook belongs to. Use to group workbooks by workspace.

Example:

"055b4db3-96e1-45e1-8ff5-3a911b779a53"

​
workspaceName
string

Display name of the parent workspace.

Example:

"Link_v2"

​
workspaceCreatedBy
integer

User ID who created the workspace.

Example:

371

​
tableCreatedBy
integer

User ID who created the workbook.

Example:

371

​
uiMetadata
object

Display metadata for the workbook.