Get Workflow Instances for a file/folder
This API lists all workflow instances associated with a specific file or folder.
Use this to check all workflows that have been started on the resource, along with their current statuses.
Endpoints
OAuth Scope
WorkDrive.files.READCopied!
curl --request GET \
--url https://www.zohoapis.com/workdrive/api/v1/files/{resource_id}/workflowinstances \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Path Parameters
resource_idstring(Required)
The unique ID of the file or folder.
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
filter[status]string(Optional)
Allowed values: "in_progress" or "completed".
Use this filter to retrieve workflow instances based on their current execution state.
page[limit]string(Optional)
Limit indicates the number of items to be listed.
(The maximum limit is 50).
For More Details about pagination. refer here
page[offset]string(Optional)
Offset indicates from where the listing should start.
{
"data": [
{
"id": "lvvnv97ff56c2275c41bba19b112f0e81e363-7321386000000367041",
"type": "workflowinstances",
"attributes": {
"initiated_by": "107845603",
"workflow_info": {
"name": "Review and Approval",
"description": "Get review feedback for the file and get a formal approval.",
"workflow_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003191"
},
"initiated_time": "Dec 8, 3:47 PM",
"workflow_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003191",
"initiated_by_user": "Sofia",
"initiated_time_in_millis": 1765189056174,
"resource_icon_class": "img",
"current_state_info": {
"name": "Approved",
"description": "The file has been approved",
"state_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003205"
},
"initiated_by_avatar_url": "https://contacts.zoho.com/file?t=user&ID=107845603&fs=thumb&nps=404",
"status_changed_time_in_millis": 1765189386231,
"status_changed_time": "Dec 8, 3:53 PM",
"resource_id": "lvvnv97ff56c2275c41bba19b112f0e81e363",
"instance_status": 2,
"resource_name": "image (16).png"
},
"relationships": {
"transitionusers": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/lvvnv97ff56c2275c41bba19b112f0e81e363-7321386000000367041/relationships/transitionusers",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/lvvnv97ff56c2275c41bba19b112f0e81e363-7321386000000367041/transitionusers"
}
},
"instancelogs": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/lvvnv97ff56c2275c41bba19b112f0e81e363-7321386000000367041/relationships/instancelogs",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/lvvnv97ff56c2275c41bba19b112f0e81e363-7321386000000367041/instancelogs"
}
},
"workflowactions": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/lvvnv97ff56c2275c41bba19b112f0e81e363-7321386000000367041/relationships/workflowactions",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/lvvnv97ff56c2275c41bba19b112f0e81e363-7321386000000367041/workflowactions"
}
},
"transitions": {
"data": [],
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/lvvnv97ff56c2275c41bba19b112f0e81e363-7321386000000367041/relationships/transitions",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/lvvnv97ff56c2275c41bba19b112f0e81e363-7321386000000367041/transitions"
}
}
},
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/lvvnv97ff56c2275c41bba19b112f0e81e363-7321386000000367041"
}
},
{
"id": "lvvnv97ff56c2275c41bba19b112f0e81e363-7321386000000367018",
"type": "workflowinstances",
"attributes": {
"initiated_by": "107845603",
"workflow_info": {
"name": "Review",
"description": "Get file reviewed by a colleague, teammate, or friend of your choice.",
"workflow_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003010"
},
"initiated_time": "Dec 8, 3:46 PM",
"workflow_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003010",
"initiated_by_user": "Sofia",
"initiated_time_in_millis": 1765189000733,
"resource_icon_class": "img",
"current_state_info": {
"name": "Review Requested",
"description": "The file is awaiting your review confirmation",
"state_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003020"
},
"initiated_by_avatar_url": "https://contacts.zoho.com/file?t=user&ID=107845603&fs=thumb&nps=404",
"status_changed_time_in_millis": 1765189006451,
"status_changed_time": "Dec 8, 3:46 PM",
"resource_id": "lvvnv97ff56c2275c41bba19b112f0e81e363",
"instance_status": 4,
"resource_name": "image (16).png"
},
"relationships": {
"transitionusers": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/lvvnv97ff56c2275c41bba19b112f0e81e363-7321386000000367018/relationships/transitionusers",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/lvvnv97ff56c2275c41bba19b112f0e81e363-7321386000000367018/transitionusers"
}
},
"instancelogs": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/lvvnv97ff56c2275c41bba19b112f0e81e363-7321386000000367018/relationships/instancelogs",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/lvvnv97ff56c2275c41bba19b112f0e81e363-7321386000000367018/instancelogs"
}
},
"workflowactions": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/lvvnv97ff56c2275c41bba19b112f0e81e363-7321386000000367018/relationships/workflowactions",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/lvvnv97ff56c2275c41bba19b112f0e81e363-7321386000000367018/workflowactions"
}
},
"transitions": {
"data": [],
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/lvvnv97ff56c2275c41bba19b112f0e81e363-7321386000000367018/relationships/transitions",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/lvvnv97ff56c2275c41bba19b112f0e81e363-7321386000000367018/transitions"
}
}
},
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/lvvnv97ff56c2275c41bba19b112f0e81e363-7321386000000367018"
}
}
]
}
{
"errors": [
{
"id": "R008",
"title": "Unauthorized access"
}
]
}
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.