- Overview
- Development Guide
- Filter Demo
- Guidelines for Using Filters
- Field Type Comparison Table
- ErrorCode
- App
- Conversational bot
- Worksheet
- Worksheet row records
- Get row record listPOST
- Get row record detailsGET
- Update row recordPATCH
- Delete row recordDELETE
- Create row recordPOST
- Batch add row recordsPOST
- Batch update row record detailsPATCH
- Batch delete row recordsDELETE
- Get relation recordsGET
- Get row record pivot dataPOST
- Get record sharing linkPOST
- Get row record logsGET
- Get row record discussionsGET
- Get approval workflow execution detailsGET
- Get approval process execution list by row recordPOST
- Get row record list
- Custom page
- Option set
- Public query
- Knowledge base
- view
- Workflow
- Role
- Chart
- Schemas
- Schemas
- options
- relation
- obj_base_response
- obj_field
- obj_filter
- 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
- FilterTarget
- FilterField
- 鉴权信息
- 人员对象
- 自定义页面
- 应用角色
- 人员信息
- 统计图数值字段参数
- ApiError
- BatchCreateViewsRequest
- DataScope
- ViewItem
- Aggregation
- BatchCreateViewsResponse
- TimeRange
- ChartType
- DynamicRangePoint
- DimensionItem
- MetricItem
- SortItem
- CreateChartData
- InlineChartConfig
- ViewConfig
- TextConfig
- HtmlConfig
- CarouselConfig
- ButtonActionItem
- ButtonConfig
- TabConfig
- ContainerConfig
- ChartComponent
- SectionComponent
- TextComponent
- HtmlComponent
- ViewComponent
- CarouselComponent
- ButtonComponent
- TabComponent
- ContainerComponent
- SaveCustomPageComponent
- SaveCustomPageData
- ComponentConfig
- SaveCustomPageRequest
- app
- CreateChartRequest
- SaveCustomPageResponseData
- CreateChartResponseData
- ButtonItem
- Base response object
- DimensionField
- memberInfo
- ValueField
- department_with_path
- SortField
- departmentInfo
- TimePointDynamic
- regionInfo
- process
- process_detail
- CustomDynamicRange
- input
- CustomRange
- output
- role
- role_permission
- optionset
- field
- CreateChartResponse
- PageComponent
- Position
- filter_children
- ErrorResponse
- discussion
- TabItem
- SaveCustomPageResponse
- User
- WorkflowInputParameter
- WorkflowOutputParameter
- WorkflowNode
- WorkflowValidationError
- create_process_NodeRef
- create_process_ValueRef
- create_process_FieldValueRef
- create_process_Filter
- create_process_Condition
- create_process_WorksheetEventTriggerConfig
- create_process_ScheduleTriggerConfig
- create_process_DateFieldTriggerConfig
- create_process_WebhookTriggerConfig
- create_process_TriggerSpec
- batch_create_process_nodes_NodeRef
- batch_create_process_nodes_ValueRef
- batch_create_process_nodes_FieldValueRef
- batch_create_process_nodes_RecordValueRef
- batch_create_process_nodes_FieldPatch
- batch_create_process_nodes_Filter
- batch_create_process_nodes_Condition
- batch_create_process_nodes_PersonRef
- batch_create_process_nodes_AttachmentSpec
- batch_create_process_nodes_FormProperty
- batch_create_process_nodes_NodeSpec
- batch_create_process_nodes_SortSpec
- ApiResponseBase
- WorkflowListType
- WorkflowInstanceStatus
- FlowNodeType
- InstanceLogStatus
- WorkItemOperationType
- WorkItemLogAction
- ApprovalAuthType
- BatchRuleType
- CallbackType
- TriggerType
- AppType
- ApprovalResultBranchType
- FailureCause
- SignatureType
- AppBrief
- UserBrief
- ControlValue
- FlowNodeAuth
- SelectNodeObject
- FlowNode
- InstanceLog
- ProcessBrief
- FileInfo
- Signature
- WorkItem
- WorkItemLog
- ChangedField
- WorkflowInstance
- BatchApprovalRequest
- BatchApprovalInstance
- BatchApprovalResult
- OpinionRequest
- ReturnRequest
- bundled_2af3dc97c2fe
- bundled_da9b1112b2d5
- bundled_66310009f584
- custom_page
- worksheet
- filter
- record_row
- Schemas
Get row record list
POST
/v3/app/worksheets/{worksheet_id}/rows/list
Request
Path Params
Header Params
Body Params application/json
Example
{
"pageSize": 20,
"pageIndex": 1,
"viewId": "view_123",
"fields": [
"field1",
"field2"
],
"filter": {
"type": "group",
"logic": "OR",
"children": [
{
"type": "group",
"logic": "AND",
"children": [
{
"type": "condition",
"field": "677b4a73d14fcf3edf4e7f15",
"operator": "eq",
"value": [
"1"
]
},
{
"type": "condition",
"field": "677b4a73d14fcf3edf4e7f15",
"operator": "eq",
"value": "test"
}
]
}
]
},
"sorts": {
"type": "array",
"description": "Sort field",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "Field ID or alias"
},
"isAsc": {
"type": "boolean",
"description": "Whether ascending; descending by default"
}
},
"required": [
"field"
]
}
},
"example": {
"pageSize": 20,
"pageIndex": 1,
"viewId": "view_123",
"fields": [
"field1",
"field2"
],
"filter": {
"type": "group",
"logic": "OR",
"children": [
{
"type": "group",
"logic": "AND",
"children": [
{
"type": "condition",
"field": "677b4a73d14fcf3edf4e7f15",
"operator": "eq",
"value": [
"1"
]
},
{
"type": "condition",
"field": "677b4a73d14fcf3edf4e7f15",
"operator": "eq",
"value": "test"
}
]
}
]
},
"sorts": [
{
"field": "createdAt",
"isAsc": true
}
]
}
}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 'https://www.nocoly.com/v3/app/worksheets//rows/list' \
--header 'HAP-Appkey: {{appkey}}' \
--header 'HAP-Sign: {{sign}}' \
--header 'Content-Type: application/json' \
--data '{
"pageSize": 20,
"pageIndex": 1,
"viewId": "view_123",
"fields": [
"field1",
"field2"
],
"filter": {
"type": "group",
"logic": "OR",
"children": [
{
"type": "group",
"logic": "AND",
"children": [
{
"type": "condition",
"field": "677b4a73d14fcf3edf4e7f15",
"operator": "eq",
"value": [
"1"
]
},
{
"type": "condition",
"field": "677b4a73d14fcf3edf4e7f15",
"operator": "eq",
"value": "test"
}
]
}
]
},
"sorts": {
"type": "array",
"description": "Sort field",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "Field ID or alias"
},
"isAsc": {
"type": "boolean",
"description": "Whether ascending; descending by default"
}
},
"required": [
"field"
]
}
},
"example": {
"pageSize": 20,
"pageIndex": 1,
"viewId": "view_123",
"fields": [
"field1",
"field2"
],
"filter": {
"type": "group",
"logic": "OR",
"children": [
{
"type": "group",
"logic": "AND",
"children": [
{
"type": "condition",
"field": "677b4a73d14fcf3edf4e7f15",
"operator": "eq",
"value": [
"1"
]
},
{
"type": "condition",
"field": "677b4a73d14fcf3edf4e7f15",
"operator": "eq",
"value": "test"
}
]
}
]
},
"sorts": [
{
"field": "createdAt",
"isAsc": true
}
]
}
}'Responses
🟢200Success
application/json
Bodyapplication/json
Example
{
"data": {
"rows": [
{
"id": "row123",
"fields": [
{
"id": "field1",
"value": "Sample value",
"type": "2",
"controlName": "Text field"
}
],
"_createdBy": {
"accountId": "user123",
"fullname": "Zhang San"
},
"_owner": {
"accountId": "user123",
"fullname": "Zhang San"
},
"_createdAt": "2024-03-25 15:52:58",
"_updatedAt": "2024-03-25 15:52:58",
"_updatedBy": {
"accountId": "user123",
"fullname": "Zhang San"
}
}
],
"total": 100,
"pageIndex": 1,
"pageSize": 20
},
"success": true
}Modified at 2026-06-25 10:21:06