Workflow Endpoints

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.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-extend-api-versionenumOptional

API version to use for the request. If you 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.

Allowed values:

Query parameters

statusenumOptional

Filters workflow runs by their status. If not provided, no filter is applied.

The status of a workflow run:

  • "PENDING" - The workflow run has not started yet
  • "PROCESSING" - The workflow run is in progress
  • "NEEDS_REVIEW" - The workflow run requires manual review
  • "REJECTED" - The workflow run was rejected during manual review
  • "PROCESSED" - The workflow run completed successfully
  • "FAILED" - The workflow run encountered an error
workflowIdstringOptional

Filters workflow runs by the workflow ID. If not provided, runs for all workflows are returned.

Example: "workflow_BMdfq_yWM3sT-ZzvCnA3f"

fileNameContainsstringOptional

Filters workflow runs by the name of the file. Only returns workflow runs where the file name contains this string.

Example: "invoice"

sortByenumOptionalDefaults to updatedAt

Sorts the workflow runs by the given field.

Allowed values:
sortDirenumOptionalDefaults to desc

Sorts the workflow runs in ascending or descending order. Ascending order means the earliest workflow run is returned first.

Allowed values:
nextPageTokenstringOptional

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.

example: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="

maxPageSizeintegerOptional>=1<=1000Defaults to 10

The maximum number of results to return in the response. You may receive less than this number if there are fewer results than the maximum.

Response

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.

successboolean
workflowRunslist of objects
nextPageTokenstringOptional

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.

example: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="

Errors