Get Workbook Data

1️⃣ Overview

Purpose:
Retrieves records from a workbook within a workspace using cursor-based pagination.

Supports:

• Filtering queries

• Sorting rules

• Pagination traversal

---

2️⃣ Endpoint

POST /noCo/api/v2/workspaces/{workspaceId}/tables/{workbookId}/cursor

---

3️⃣ Path Parameters

Parameter	Type	Required	Description
workspaceId	UUID	✅ Yes	Workspace identifier
workbookId	UUID	✅ Yes	Workbook identifier

---

4️⃣ Authentication

Requires authentication using:

Authorization: Bearer <token>

---

5️⃣ Request Headers

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

---

6️⃣ Request Body Schema

{
  "requestPageDetails": {
    "pageNumber": 1,
    "pageSize": 500
  },
  "sortOptions": [],
  "whereClause": "string"
}

---

7️⃣ Field Descriptions

Pagination Configuration

Field	Type	Required	Description
requestPageDetails	object	✅ Yes	Pagination configuration
requestPageDetails.pageNumber	number	✅ Yes	Page number to retrieve (increment to fetch next page)
requestPageDetails.pageSize	number	✅ Yes	Number of records per page
sortOptions	array	❌ No	Sorting rules for query results
whereClause	string	❌ No	SQL-like conditional filter expression

---

8️⃣ Example Request

curl -X POST https://be.datagol.ai/noCo/api/v2/workspaces/{workspaceId}/tables/{workbookId}/cursor \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
  "requestPageDetails": {
    "pageNumber": 1,
    "pageSize": 500
  },
  "sortOptions": [
    {
      "columnName": "first_name",
      "direction": "DESC"
    },{
      "columnName": "last_updated",
      "direction": "ASC"
    } 
  ],
  "whereClause": "(`first_name` like '%d%' and `years_of_experience` > 4 and `start_date` between '2004-01-01' and '2009-12-31' and `is_active` = true)"
}'

---

9️⃣ Behavior Summary

Retrieves workbook records using cursor-based pagination.
Supports:
• Dynamic filtering using whereClause
• Multi-field sorting using sortOptions
• Efficient pagination traversal using pageNumber and pageSize
• Large dataset handling without loading entire workbook data