Skip to main content

List Workflow Executions

GET 

https://sailpoint.api.identitynow.com/v2024/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 offset parameter. 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

Path Parameters

    id stringrequired

    Workflow ID.

Query Parameters

    limit int32

    Possible values: <= 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Default value: 250
    Example: 250
    offset int32

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Default value: 0
    Example: 0
    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.

    Default value: false
    Example: true
    filters string

    Filter results using the standard syntax described in V3 API Standard Collection Parameters

    Filtering is supported for the following fields and operators:

    start_time: eq, lt, le, gt, ge

    status: eq

    Example: status eq "Failed"

Responses

List of workflow executions for the specified workflow.

Schema
  • Array [
  • idstring

    Workflow execution ID.

    Example: b393f4e2-4785-4d7f-ab27-3a6b8ded4c81
    workflowIdstring

    Workflow ID.

    Example: d201c5d9-d37b-4a2f-af14-66414f39d568
    requestIdstring

    Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes.

    Example: 41e12a74fa7b4a6a98ae47887b64acdb
    startTimedate-time

    Date/time when the workflow started.

    Example: 2022-02-07T20:13:29.356648026Z
    closeTimedate-time

    Date/time when the workflow ended.

    Example: 2022-02-07T20:13:31.682410165Z
    statusstring

    Workflow execution status.

    Possible values: [Completed, Failed, Canceled, Queued, Running]

    Example: Completed
  • ]

Authorization: oauth2

type: Personal Access Token
scopes: sp:workflow:read

Request Collapse all
Base URL
https://sailpoint.api.identitynow.com/v2024
Auth
Parameters
— pathrequired
— query
— query
— query
— query
ResponseClear

Click the Send API Request button above and see the response here!