Get Workflow Instances for a User
This API retrieves all workflow instances that were either initiated by a specific user or assigned to them.
Use this to track workflows a user created, workflows awaiting their action, or to filter instances by execution type, status, resource type, or initiation time.
Endpoints
OAuth Scope
WorkDrive.users.READCopied!
curl --request GET \
--url 'https://www.zohoapis.com/workdrive/api/v1/users/{team_member_id}/workflowinstances?filter%5Binstance_role%5D=assignee' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Path Parameters
team_member_idstring(Required)
The unique ID of the user.
Query Parameters
Note:
Query parameter name should be URL encoded with UTF-8 Charset. For more info, refer here
filter[instance_role]string(Required)
Allowed values: "assignee" or "creator".
Allowed Values :
Show Values ▾
assigneeCopied!
creatorCopied!
Copy all as JSON Array
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[initiation_type]string(Optional)
Allowed values: "automatic" or "manual_start".
Filters instances based on how the workflow was initiated.
Allowed Values :
Show Values ▾
automaticCopied!
manual_startCopied!
Copy all as JSON Array
filter[resource_type]string(Optional)
Provide the file or folder type to restrict results to specific resource categories.
Please refer to File Filter table from this filter section to get values.
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.
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.
Allowed values:
- initiated_time - Sort by when the workflow was initiated.
- status_changed_time - Sort by the last status update time.
To sort in descending order, prefix the field value with a hyphen (-).
Example: sort=-initiated_time sorts results by initiated time in descending order.
Allowed Values :
Show Values ▾
initiated_timeCopied!
status_changed_timeCopied!
-initiated_timeCopied!
-status_changed_timeCopied!
Copy all as JSON Array
{
"data": [
{
"id": "ppjqv45aa710e2a7641c39afcd1943af68bc4-2685475000014334100",
"type": "workflowinstances",
"attributes": {
"initiated_by": "73961783",
"workflow_info": {
"name": "Review and approval",
"description": "",
"workflow_id": "lnz3zae81adec44df4fea966a38e427014c07-2685475000011046009"
},
"initiated_time": "Dec 4, 11:49 AM",
"workflow_id": "lnz3zae81adec44df4fea966a38e427014c07-2685475000011046009",
"initiated_by_user": "Sofia",
"initiated_time_in_millis": 1764829151119,
"resource_icon_class": "sheet",
"current_state_info": {
"name": "Waiting for approval",
"description": "",
"state_id": "lnz3zae81adec44df4fea966a38e427014c07-2685475000011046025"
},
"initiated_by_avatar_url": "https://contacts.zoho.com/file?t=user&ID=73961783&fs=thumb&nps=404",
"status_changed_time_in_millis": 1764925232802,
"status_changed_time": "Dec 5, 2:30 PM",
"resource_id": "ppjqv45aa710e2a7641c39afcd1943af68bc4",
"instance_status": 1,
"resource_name": "Module Report"
},
"relationships": {
"transitionusers": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/ppjqv45aa710e2a7641c39afcd1943af68bc4-2685475000014334100/relationships/transitionusers",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/ppjqv45aa710e2a7641c39afcd1943af68bc4-2685475000014334100/transitionusers"
}
},
"instancelogs": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/ppjqv45aa710e2a7641c39afcd1943af68bc4-2685475000014334100/relationships/instancelogs",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/ppjqv45aa710e2a7641c39afcd1943af68bc4-2685475000014334100/instancelogs"
}
},
"workflowactions": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/ppjqv45aa710e2a7641c39afcd1943af68bc4-2685475000014334100/relationships/workflowactions",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/ppjqv45aa710e2a7641c39afcd1943af68bc4-2685475000014334100/workflowactions"
}
},
"transitions": {
"data": [],
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/ppjqv45aa710e2a7641c39afcd1943af68bc4-2685475000014334100/relationships/transitions",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/ppjqv45aa710e2a7641c39afcd1943af68bc4-2685475000014334100/transitions"
}
}
},
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/ppjqv45aa710e2a7641c39afcd1943af68bc4-2685475000014334100"
}
},
{
"id": "iub282f7970fd4ba14536afa08e5ff971a5d6-2685475000014353003",
"type": "workflowinstances",
"attributes": {
"initiated_by": "68544251",
"workflow_info": {
"name": "Review",
"description": "",
"workflow_id": "lnz3zae81adec44df4fea966a38e427014c07-2685475000011485001"
},
"initiated_time": "Dec 5, 11:15 AM",
"workflow_id": "lnz3zae81adec44df4fea966a38e427014c07-2685475000011485001",
"initiated_by_user": "Zylker",
"initiated_time_in_millis": 1764913552620,
"resource_icon_class": "writer",
"current_state_info": {
"name": "Review Requested",
"description": "The file is awaiting your review confirmation",
"state_id": "lnz3zae81adec44df4fea966a38e427014c07-2685475000011485010"
},
"initiated_by_avatar_url": "https://contacts.zoho.com/file?t=user&ID=68544251&fs=thumb&nps=404",
"status_changed_time_in_millis": 1764913553092,
"status_changed_time": "Dec 5, 11:15 AM",
"resource_id": "iub282f7970fd4ba14536afa08e5ff971a5d6",
"instance_status": 1,
"resource_name": "Feature PRD template"
},
"relationships": {
"transitionusers": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/iub282f7970fd4ba14536afa08e5ff971a5d6-2685475000014353003/relationships/transitionusers",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/iub282f7970fd4ba14536afa08e5ff971a5d6-2685475000014353003/transitionusers"
}
},
"instancelogs": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/iub282f7970fd4ba14536afa08e5ff971a5d6-2685475000014353003/relationships/instancelogs",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/iub282f7970fd4ba14536afa08e5ff971a5d6-2685475000014353003/instancelogs"
}
},
"workflowactions": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/iub282f7970fd4ba14536afa08e5ff971a5d6-2685475000014353003/relationships/workflowactions",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/iub282f7970fd4ba14536afa08e5ff971a5d6-2685475000014353003/workflowactions"
}
},
"transitions": {
"data": [],
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/iub282f7970fd4ba14536afa08e5ff971a5d6-2685475000014353003/relationships/transitions",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/iub282f7970fd4ba14536afa08e5ff971a5d6-2685475000014353003/transitions"
}
}
},
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/iub282f7970fd4ba14536afa08e5ff971a5d6-2685475000014353003"
}
},
{
"id": "in5lv2dee2a949eee4bf5924053b529bdd74b-2685475000014308017",
"type": "workflowinstances",
"attributes": {
"initiated_by": "68544415",
"workflow_info": {
"name": "Review",
"description": "",
"workflow_id": "lnz3zae81adec44df4fea966a38e427014c07-2685475000011485001"
},
"initiated_time": "Dec 1, 11:45 AM",
"workflow_id": "lnz3zae81adec44df4fea966a38e427014c07-2685475000011485001",
"initiated_by_user": "Zylker",
"initiated_time_in_millis": 1764569727494,
"resource_icon_class": "writer",
"current_state_info": {
"name": "Review Requested",
"description": "The file is awaiting your review confirmation",
"state_id": "lnz3zae81adec44df4fea966a38e427014c07-2685475000011485010"
},
"initiated_by_avatar_url": "https://contacts.zoho.com/file?t=user&ID=68544415&fs=thumb&nps=404",
"status_changed_time_in_millis": 1764569727946,
"status_changed_time": "Dec 1, 11:45 AM",
"resource_id": "in5lv2dee2a949eee4bf5924053b529bdd74b",
"instance_status": 1,
"resource_name": "Export report"
},
"relationships": {
"transitionusers": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/in5lv2dee2a949eee4bf5924053b529bdd74b-2685475000014308017/relationships/transitionusers",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/in5lv2dee2a949eee4bf5924053b529bdd74b-2685475000014308017/transitionusers"
}
},
"instancelogs": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/in5lv2dee2a949eee4bf5924053b529bdd74b-2685475000014308017/relationships/instancelogs",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/in5lv2dee2a949eee4bf5924053b529bdd74b-2685475000014308017/instancelogs"
}
},
"workflowactions": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/in5lv2dee2a949eee4bf5924053b529bdd74b-2685475000014308017/relationships/workflowactions",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/in5lv2dee2a949eee4bf5924053b529bdd74b-2685475000014308017/workflowactions"
}
},
"transitions": {
"data": [],
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/in5lv2dee2a949eee4bf5924053b529bdd74b-2685475000014308017/relationships/transitions",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/in5lv2dee2a949eee4bf5924053b529bdd74b-2685475000014308017/transitions"
}
}
},
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/in5lv2dee2a949eee4bf5924053b529bdd74b-2685475000014308017"
}
},
{
"id": "gloxyb598b961f0114ee591200b6b9b5e3d51-2685475000014308003",
"type": "workflowinstances",
"attributes": {
"initiated_by": "68544415",
"workflow_info": {
"name": "Review",
"description": "",
"workflow_id": "lnz3zae81adec44df4fea966a38e427014c07-2685475000011485001"
},
"initiated_time": "Nov 28, 3:06 PM",
"workflow_id": "lnz3zae81adec44df4fea966a38e427014c07-2685475000011485001",
"initiated_by_user": "Sofia",
"initiated_time_in_millis": 1764322604235,
"resource_icon_class": "writer",
"current_state_info": {
"name": "Review Requested",
"description": "The file is awaiting your review confirmation",
"state_id": "lnz3zae81adec44df4fea966a38e427014c07-2685475000011485010"
},
"initiated_by_avatar_url": "https://contacts.zoho.com/file?t=user&ID=68544415&fs=thumb&nps=404",
"status_changed_time_in_millis": 1764322607904,
"status_changed_time": "Nov 28, 3:06 PM",
"resource_id": "gloxyb598b961f0114ee591200b6b9b5e3d51",
"instance_status": 1,
"resource_name": "Marketing content"
},
"relationships": {
"transitionusers": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/gloxyb598b961f0114ee591200b6b9b5e3d51-2685475000014308003/relationships/transitionusers",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/gloxyb598b961f0114ee591200b6b9b5e3d51-2685475000014308003/transitionusers"
}
},
"instancelogs": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/gloxyb598b961f0114ee591200b6b9b5e3d51-2685475000014308003/relationships/instancelogs",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/gloxyb598b961f0114ee591200b6b9b5e3d51-2685475000014308003/instancelogs"
}
},
"workflowactions": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/gloxyb598b961f0114ee591200b6b9b5e3d51-2685475000014308003/relationships/workflowactions",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/gloxyb598b961f0114ee591200b6b9b5e3d51-2685475000014308003/workflowactions"
}
},
"transitions": {
"data": [],
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/gloxyb598b961f0114ee591200b6b9b5e3d51-2685475000014308003/relationships/transitions",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/gloxyb598b961f0114ee591200b6b9b5e3d51-2685475000014308003/transitions"
}
}
},
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/gloxyb598b961f0114ee591200b6b9b5e3d51-2685475000014308003"
}
}
]
}
{
"errors": [
{
"id": "R008",
"title": "Unauthorized access"
}
]
}
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.