Fetching detailed workflow execution logs

Retrieve comprehensive logs for workflow executions.

Before you begin

You must have read, write, or execute permission on the project.

Procedure

  1. In a REST client platform, add authentication details of the tenant. 
    
//In case of Instance API key 
Headers:
{
"x-instance-api-key": "instance_api_key"
}
 
// In case of MCSP or ISV token
Headers:
{
"Authorization": "mcsp_or_isv_token"
}
  2. Make a GET request at the URL of the workflow.

    URL Syntax - /apis/v2/rest/workflow/execution/:run_id/logs?qualifier=workflow&direction=asc&field=created_at

    direction (optional): Sort order of logs, default is asc.

    field (optional): Field to sort by, default is created_at.

    If the request is successful, you receive the response code for success.
    {
"objects": [
{
"uid": "<uid_id>",
"type": "manual-payload",
"error": false,
"tenant_uid": "<tenant_uid>",
"checkpoint": false,
"payload": {
"data": {},
"type": "manual-request",
"bill_uid": "<bill_uid>",
"flow_uid": "<flow_uid>",
"tenant_uid": "<tenant_uid",
"sync": false,
"url": "",
"method": "post",
"query": {},
"headers": {}
}
},
{
"created_at": "2025-08-01T12:49:59.300Z",
"run_id": <run_id>,
"tenant_uid": "<tenant_uid>",
"type": "system",
"status": "action completed",
"activity_id": "start",
"activity_label": "Start"
}
]
}
    Note: Response fields such as run_id, workflow_uid, status, error, checkpoint, payload, activity_id, activity_label, and message_expression appear only if applicable.