List Workflow Runs
List runs of a Workflow. Workflows are sequences of steps that process files and data in a specific order to achieve a desired outcome. A WorkflowRun represents a single execution of a workflow against a file.
Bearer authentication of the form Bearer <token>, where token is your auth token.
Filters workflow runs by the workflow ID. If not provided, runs for all workflows are returned.
Example: "workflow_BMdfq_yWM3sT-ZzvCnA3f"
Filters runs by the name of the file. Only returns runs where the file name contains this string.
Example: "invoice"
The token used to fetch the page of results from a previous request. We use cursor based pagination and will return a nextPageToken in the response if there are more results.
Note that if other parameters are changed in subsequent requests, you may receive inconsistent data.
The token used to fetch the page of results from a previous request. We use cursor based pagination and will return a nextPageToken in the response if there are more results.
Note that if other parameters are changed in subsequent requests, you may receive inconsistent data.
API version to use for the request. If you’re using an SDK, you can ignore this parameter. If you are not using an SDK and do not specify a version, you will either receive a 400 Bad Request or be set to a previous legacy version. See API Versioning for more details.
The workspace ID to target. Required when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See Authentication for details on API key scopes.
The status of a workflow run:
"PENDING" - The workflow run is waiting to be processed"PROCESSING" - The workflow run is currently processing"NEEDS_REVIEW" - The workflow run requires manual review"REJECTED" - The workflow run was rejected during review"PROCESSED" - The workflow run completed successfully"FAILED" - The workflow run encountered an error"CANCELLED" - The workflow run was cancelled"CANCELLING" - The workflow run is being cancelledFilters workflow runs by the batch ID. This is useful for fetching all runs for a given batch created via the Batch Run Workflow endpoint.
Example: "batch_7Ws31-F5"
You will get a list of summaries for each workflow run. These are shortened versions of the full WorkflowRun object.
To get the full object, use the Get WorkflowRun endpoint.