Get Workflow Instance
This API retrieves the complete details of a specific workflow instance, including its current state, associated transitions, and metadata.
Endpoints
OAuth Scope
WorkDrive.workflowinstances.READCopied!
curl --request GET \
--url https://www.zohoapis.com/workdrive/api/v1/workflowinstances/{instance_id} \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Path Parameters
instance_idstring(Required)
The unique ID of the workflow instance.
{
"data": {
"id": "sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000367116",
"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, 5:15 PM",
"workflow_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003010",
"custom_meta_data": {
"data_template_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003011",
"name": "Automation_Review",
"description": "",
"custom_data": [
{
"custom_field_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-NzMyMTM4NjAwMDAwMDAwMzAxMS03MzIxMzg2MDAwMDAwMDAzMDE1",
"display_name": "Reviewers",
"type": "multi_email",
"column_name": "CF1",
"api_name": "cf_7321386000000003015",
"field_properties": {
"description": "",
"is_mandatory": true,
"is_searchable": true
},
"value": [
"reyansh.ahuja@zylker.com"
],
"index": 0,
"multi_email_additional_info": [
{
"email_id": "reyansh.ahuja@zylker.com",
"user_id": "68544415",
"display_name": "Zylker Creation",
"avatar_url": "https://contacts.zoho.com/file?t=user&ID=68544415&fs=thumb&nps=404"
}
]
},
{
"custom_field_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-NzMyMTM4NjAwMDAwMDAwMzAxMS03MzIxMzg2MDAwMDAwMDAzMDE2",
"display_name": "Note from the Author",
"type": "multiline_text",
"column_name": "CF2",
"api_name": "cf_7321386000000003016",
"field_properties": {
"description": "",
"is_mandatory": true,
"is_searchable": true
},
"value": "kindly review this document",
"index": 1
},
{
"custom_field_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-NzMyMTM4NjAwMDAwMDAwMzAxMS03MzIxMzg2MDAwMDAwMDAzMDE3",
"display_name": "Review due date",
"type": "datetime",
"column_name": "CF601",
"api_name": "cf_7321386000000003017",
"field_properties": {
"description": "",
"is_mandatory": false,
"is_searchable": true,
"default_value": "",
"allowed_date": {
"allowed_date_type": "FUTURE"
}
},
"value": "1766039400000",
"index": 2
},
{
"custom_field_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-NzMyMTM4NjAwMDAwMDAwMzAxMS03MzIxMzg2MDAwMDAwMDAzMDE5",
"display_name": "Reviewer notes",
"type": "multiline_text",
"column_name": "CF3",
"api_name": "cf_7321386000000003019",
"field_properties": {
"description": "",
"is_mandatory": true,
"is_searchable": true
},
"value": "looks fine",
"index": 3
}
],
"status": true,
"is_associated_without_cf": false,
"data_template_type": 2
},
"initiated_by_user": "Sofia",
"initiated_time_in_millis": 1765194306487,
"resource_icon_class": "pdf",
"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": 1765194306630,
"status_changed_time": "Dec 8, 5:15 PM",
"resource_id": "sfftbc5c0bf2f5d234f289b24d675b5e02507",
"instance_status": 1,
"resource_name": "Getting Started for Team Members.pdf"
},
"relationships": {
"transitionusers": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000367116/relationships/transitionusers",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000367116/transitionusers"
}
},
"instancelogs": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000367116/relationships/instancelogs",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000367116/instancelogs"
}
},
"workflowactions": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000367116/relationships/workflowactions",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000367116/workflowactions"
}
},
"transitions": {
"data": [
{
"id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003062",
"type": "transitions"
},
{
"id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003092",
"type": "transitions"
}
],
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000367116/relationships/transitions",
"related": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000367116/transitions"
}
}
},
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/workflowinstances/sfftbc5c0bf2f5d234f289b24d675b5e02507-7321386000000367116"
}
},
"included": [
{
"id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003062",
"type": "transitions",
"attributes": {
"workflow_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003010",
"target_state_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003041",
"module": "FILE",
"source_state_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003020",
"name": "Complete review",
"description": "",
"transition_id_str": "7321386000000003062",
"can_perform_transition": false,
"triggers": [
{
"trigger_type": "MANUAL_TRANSITION",
"trigger_id_str": "7321386000000003064",
"details": {},
"trigger_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-NzMyMTM4NjAwMDAwMDAwMzA2Mi03MzIxMzg2MDAwMDAwMDAzMDY0"
}
],
"is_user_part_of_transition": true,
"completion_rule": 2
},
"relationships": {
"transitionperformers": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/transitions/sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003062/relationships/transitionperformers",
"related": "https://www.zohoapis.com/workdrive/api/v1/transitions/sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003062/transitionperformers"
}
},
"action": {
"data": [],
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/transitions/sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003062/relationships/action",
"related": "https://www.zohoapis.com/workdrive/api/v1/transitions/sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003062/action"
}
},
"workflowactions": {
"data": [],
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/transitions/sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003062/relationships/workflowactions",
"related": "https://www.zohoapis.com/workdrive/api/v1/transitions/sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003062/workflowactions"
}
}
},
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/transitions/sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003062"
}
},
{
"id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003092",
"type": "transitions",
"attributes": {
"workflow_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003010",
"target_state_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003039",
"module": "FILE",
"source_state_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003020",
"name": "Suggest changes",
"description": "",
"transition_id_str": "7321386000000003092",
"can_perform_transition": false,
"triggers": [
{
"trigger_type": "MANUAL_TRANSITION",
"trigger_id_str": "7321386000000003093",
"details": {},
"trigger_id": "sfftb8bae590ea97a4c8ba521f751b64452ca-NzMyMTM4NjAwMDAwMDAwMzA5Mi03MzIxMzg2MDAwMDAwMDAzMDkz"
}
],
"is_user_part_of_transition": true,
"completion_rule": 1
},
"relationships": {
"transitionperformers": {
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/transitions/sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003092/relationships/transitionperformers",
"related": "https://www.zohoapis.com/workdrive/api/v1/transitions/sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003092/transitionperformers"
}
},
"action": {
"data": [],
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/transitions/sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003092/relationships/action",
"related": "https://www.zohoapis.com/workdrive/api/v1/transitions/sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003092/action"
}
},
"workflowactions": {
"data": [],
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/transitions/sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003092/relationships/workflowactions",
"related": "https://www.zohoapis.com/workdrive/api/v1/transitions/sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003092/workflowactions"
}
}
},
"links": {
"self": "https://www.zohoapis.com/workdrive/api/v1/transitions/sfftb8bae590ea97a4c8ba521f751b64452ca-7321386000000003092"
}
}
]
}
{
"errors": [
{
"id": "R008",
"title": "Unauthorized access"
}
]
}
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.