Skip to main content
GET
List a debug attempt's files
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/workflows/listDebugFiles Returns the files the attempt read and wrote, by file id, name, type and size; never a storage handle. A file that carries a company you may not use workflows in (workflows:use at that company), or whose file record no longer exists, is left out, as getDebugFileUrl refuses it; get a download link for the others there.

Authentication

Personal key, External App credential or platform API key. Requires permission workflows:use, and the credential’s scopes must also reach workflows:read (a 403 naming it otherwise). Both are decided at the workflow’s home org unit. A debug attempt is personal, as in the Console: you debug drafts you created and read attempts you started. With a Personal key that is its owner; an External App or a platform key is its own creator (externalApp:<id>, apiKey:<id>). When draft debugging (workflow_debug_execution) is off for you (a Personal key’s owner) or for the deployment (an app or platform key), the route answers 409 conflict.

Query parameters

string
required
The debug attempt’s id.

Responses

200 with data.files.

Errors

Example

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

attemptId
string
required

The debug attempt's id. Give it exactly once.

Minimum string length: 1

Response

The attempt's files

data
object
required
meta
object
required