List Workflow Executions
GET {{baseUrl}}/workflows/:id/executions
Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the Get Workflows endpoint to get your workflows. 2. Get your workflow ID from the response. 3. You can then do either of the following:
Filter to find relevant workflow executions. For example, you can filter for failed workflow executions:
GET /workflows/:workflowID/executions?filters=status eq "Failed"Paginate through results with the
offsetparameter. For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to Paginating Results for more information about the query parameters you can use to achieve pagination.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
limit | number | Max number of results to return. | |
| See V3 API Standard Collection Parameters for more information. | |||
offset | number | Offset into the full result set. Usually specified with limit to paginate through the results. | |
| See V3 API Standard Collection Parameters for more information. | |||
count | boolean | If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. |
Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.
See V3 API Standard Collection Parameters for more information. |
| filters | string | | Filter results using the standard syntax described in V3 API Standard Collection Parameters
Filtering is supported for the following fields and operators:
startTime: eq, lt, le, gt, ge
status: eq |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"id":"b393f4e2-4785-4d7f-ab27-3a6b8ded4c81","workflowId":"d201c5d9-d37b-4a2f-af14-66414f39d568","requestId":"41e12a74fa7b4a6a98ae47887b64acdb","startTime":"2022-02-07T20:13:29.356648026Z","closeTime":"2022-02-07T20:13:31.682410165Z","status":"Completed"},{"id":"b393f4e2-4785-4d7f-ab27-3a6b8ded4c81","workflowId":"d201c5d9-d37b-4a2f-af14-66414f39d568","requestId":"41e12a74fa7b4a6a98ae47887b64acdb","startTime":"2022-02-07T20:13:29.356648026Z","closeTime":"2022-02-07T20:13:31.682410165Z","status":"Completed"}]