- V3 (AI-friendly-beta)
- Overview
- Field Type Comparison Table
- Guidelines for Using Filters
- Error Code
- application
- worksheet
- worksheet Row Records
- option set
- workflow
- role
- public query
- knowledge
- V2
- Filter
- Development Guide
- Filter Demo
- ErrorCode
- Options Set
- Application Role
- worksheet
- Create Worksheet
- Get worksheet structure information
- Get List
- Create Row Record
- Batch Create Row Records
- Get Row Record Details
- Get row record details
- Update Row Record Details
- Batch Update Row Record Details
- Delete Row Record
- Get associated record
- Get Record Share Link
- Get total row count of worksheet
- Get Row Record Log
- app
- Public Inquiries
- Get Row Record DiscussionsPOST
- Schemas
- Sample Schemas
- Schemas
- Authentication Information
- obj_base_response
- Person object
- obj_field
- Custom Page
- obj_filter
- Application Role
- obj_record_row
- obj_record_log
- obj_record_discussion
- obj_pivot_meta
- obj_pivot_dimensions
- obj_pivot_data
- obj_process
- obj_process_detail
- obj_input
- obj_output
- obj_role
- obj_role_permission
- obj_user
- obj_user_desensitized
- obj_department
- obj_custom_page
- obj_optionset
- obj_filter_children
- obj_app
- Base response object
- memberInfo
- department_with_path
- departmentInfo
- regionInfo
- process
- process_detail
- input
- output
- role
- role_permission
- custom_page
- optionset
- field
- worksheet
- filter
- filter_children
- record_row
- discussion
Get worksheet structure information
GET
/v3/app/worksheets/{worksheet_id}
Request
Path Params
Query Params
Header Params
Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://www.nocoly.com/v3/app/worksheets/?responseFormat' \
--header 'HAP-Appkey;' \
--header 'HAP-Sign;'Responses
🟢200OK
application/json
Body
Examples
{
"data": {
"worksheetId": "65dda1a5a608a40050774c72",
"name": "Member information",
"alias": "",
"desc": "",
"remark": "",
"fields": [
{
"id": "632444f6182c34e9180b0676",
"name": "Name",
"alias": "",
"desc": "",
"type": "2",
"required": false,
"isHidden": false,
"isReadOnly": false,
"isHiddenOnCreate": false,
"isUnique": false,
"isTitle": true,
"remark": ""
}
],
"views": [
{
"id": "65dda1a5a608a40050774c8f",
"name": "All",
"type": "0"
}
]
},
"success": true
}Modified at 2026-03-30 07:15:12