Get Workflow Instances for a Workflow
This API retrieves all workflow instances that were created using a specific workflow.
Use this to track the progress, status, and lifecycle of instances originating from a given workflow, along with time-based and state-based filtering.
Endpoints
OAuth Scope
WorkDrive.workflows.READCopied!
curl --request GET \
--url https://www.zohoapis.com/workdrive/api/v1/workflows/{workflow_id}/workflowinstances \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Path Parameters
workflow_idstring(Required)
The unique ID of the workflow.
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
filter[instance_status]string(Optional)
Allowed values: "in_progress", "completed", "aborted".
Filters instances by their current state.
Allowed Values :
Show Values ▾
in_progressCopied!
completedCopied!
abortedCopied!
Copy all as JSON Array
filter[initiated_time]string(Optional)
Allowed values: "today", "yesterday", "last_week", "last_30_days".
Quick filters to retrieve instances based on their initiation date.
Allowed Values :
Show Values ▾
todayCopied!
yesterdayCopied!
last_weekCopied!
last_30_daysCopied!
Copy all as JSON Array
filter[from_initiated_time]string(Optional)
Start of the initiation time range, in milliseconds.
filter[to_initiated_time]string(Optional)
End of the initiation time range, in milliseconds.
filter[current_state_id]string(Optional)
Filters workflow instances that are currently in the specified workflow 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.
sortstring(Optional)
Sorts the workflow instances list.
Supported values:
To sort in descending order, prefix the field value with a hyphen (-).
Eg. sort=-initiated_time sorts results by initiated time in descending order.
Allowed Values :
Show Values ▾
initiated_timeCopied!
-initiated_timeCopied!
Copy all as JSON Array
{
"data": [
{
"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": "Product logo.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"
}
},
{
"id": "sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000359101",
"type": "workflowinstances",
"attributes": {
"initiated_by": "68544415",
"workflow_info": {
"name": "Review",
"description": "Get file reviewed by a colleague, teammate, or friend of your choice.",
"workflow_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003010"
},
"initiated_time": "Dec 5, 4:45 PM",
"workflow_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003010",
"initiated_by_user": "Sofia",
"initiated_time_in_millis": 1764933326958,
"resource_icon_class": "pdf",
"current_state_info": {
"name": "Changes Suggested",
"description": "Revise the file as per the reviewer suggestions and resubmit for evaluation",
"state_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003039"
},
"initiated_by_avatar_url": "https://contacts.zoho.com/file?t=user&ID=68544415&fs=thumb&nps=404",
"status_changed_time_in_millis": 1764943829565,
"status_changed_time": "Dec 5, 7:40 PM",
"resource_id": "sfftbc5c0bf2f5d234f289b24d675b5e02507",
"instance_status": 1,
"resource_name": "Marketing report.pdf"
},
"relationships": {
"transitionusers": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000359101/relationships/transitionusers",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000359101/transitionusers"
}
},
"instancelogs": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000359101/relationships/instancelogs",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000359101/instancelogs"
}
},
"workflowactions": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000359101/relationships/workflowactions",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000359101/workflowactions"
}
},
"transitions": {
"data": [],
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000359101/relationships/transitions",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000359101/transitions"
}
}
},
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000359101"
}
},
{
"id": "sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000359059",
"type": "workflowinstances",
"attributes": {
"initiated_by": "68544415",
"workflow_info": {
"name": "Review",
"description": "Get file reviewed by a colleague, teammate, or friend of your choice.",
"workflow_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003010"
},
"initiated_time": "Dec 5, 4:42 PM",
"workflow_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003010",
"initiated_by_user": "Zylker",
"initiated_time_in_millis": 1764933126758,
"resource_icon_class": "pdf",
"current_state_info": {
"name": "Changes Suggested",
"description": "Revise the file as per the reviewer suggestions and resubmit for evaluation",
"state_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003039"
},
"initiated_by_avatar_url": "https://contacts.zoho.com/file?t=user&ID=68544415&fs=thumb&nps=404",
"status_changed_time_in_millis": 1764933259381,
"status_changed_time": "Dec 5, 4:44 PM",
"resource_id": "sfftbc5c0bf2f5d234f289b24d675b5e02507",
"instance_status": 4,
"resource_name": "Getting Started for Team Admins.pdf"
},
"relationships": {
"transitionusers": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000359059/relationships/transitionusers",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000359059/transitionusers"
}
},
"instancelogs": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000359059/relationships/instancelogs",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000359059/instancelogs"
}
},
"workflowactions": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000359059/relationships/workflowactions",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000359059/workflowactions"
}
},
"transitions": {
"data": [],
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000359059/relationships/transitions",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000359059/transitions"
}
}
},
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000359059"
}
},
{
"id": "sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000352047",
"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 4, 7:40 PM",
"workflow_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003010",
"initiated_by_user": "Zylker",
"initiated_time_in_millis": 1764857429781,
"resource_icon_class": "pdf",
"current_state_info": {
"name": "Reviewed",
"description": "The file has been reviewed",
"state_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003041"
},
"initiated_by_avatar_url": "https://contacts.zoho.com/file?t=user&ID=107845603&fs=thumb&nps=404",
"status_changed_time_in_millis": 1764932939871,
"status_changed_time": "Dec 5, 4:38 PM",
"resource_id": "sfftbc5c0bf2f5d234f289b24d675b5e02507",
"instance_status": 2,
"resource_name": "Getting Started for Team Members.pdf"
},
"relationships": {
"transitionusers": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000352047/relationships/transitionusers",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000352047/transitionusers"
}
},
"instancelogs": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000352047/relationships/instancelogs",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000352047/instancelogs"
}
},
"workflowactions": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000352047/relationships/workflowactions",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000352047/workflowactions"
}
},
"transitions": {
"data": [],
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000352047/relationships/transitions",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000352047/transitions"
}
}
},
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000352047"
}
}
]
}
{
"errors": [
{
"id": "R008",
"title": "Unauthorized access"
}
]
}
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.