WorkflowExecutions

Query workflow executions with pagination and filtering

Audience: Programmer

Returns a paginated list of Temporal workflow executions with optional filtering and ordering. This query provides lightweight execution metadata without history for efficient retrieval of workflow execution status.

For workflow history events, use the separate workflowHistory query.

Arguments

Name	Type	Description
where	WorkflowExecutionsWhereInput	Filter criteria for workflow executions
first	Int	Maximum number of executions to return. Defaults to 100
after	String	Pagination cursor from previous response (NextPageToken from Temporal)
orderBy	WorkflowExecutionOrder	Ordering options for the returned list

Return Type

WorkflowExecutionInfoConnection! - A connection containing workflow execution information with pagination support.

Connection Fields

Field	Type	Description
edges	[WorkflowExecutionInfoEdge!]!	List of workflow execution edges
pageInfo	WorkflowExecutionPageInfo!	Pagination information
totalCount	Int!	Total count of matching executions

Edge Fields

Field	Type	Description
node	WorkflowExecutionInfo!	The workflow execution information
cursor	String!	Cursor for pagination

Filter Options (WorkflowExecutionsWhereInput)

Workflow Identification

Filter	Type	Description
workflowID	String	Exact workflow ID match
workflowIDIn	[String!]	Match any of the provided workflow IDs
workflowIDHasPrefix	String	Workflow ID starts with
workflowIDContains	String	Workflow ID contains substring
runID	String	Exact run ID match
runIDIn	[String!]	Match any of the provided run IDs

Workflow Type

Filter	Type	Description
typeName	String	Exact workflow type name
typeNameIn	[String!]	Match any of the provided type names
typeNameContains	String	Type name contains substring
typeNameHasPrefix	String	Type name starts with

Status

Filter	Type	Description
status	String	Exact status match (RUNNING, COMPLETED, FAILED, etc.)
statusIn	[String!]	Match any of the provided statuses
statusNotIn	[String!]	Exclude specific statuses

Time Filters

Filter	Type	Description
startTime	String	Exact start time (ISO 8601)
startTimeGT	String	Started after
startTimeGTE	String	Started at or after
startTimeLT	String	Started before
startTimeLTE	String	Started at or before
closeTime	String	Exact close time
closeTimeGT	String	Closed after
closeTimeGTE	String	Closed at or after
closeTimeIsNil	Boolean	Still running (no close time)
closeTimeNotNil	Boolean	Has completed (has close time)

Search Attributes

Filter	Type	Description
service	String	Service name search attribute
serviceIn	[String!]	Match any of the services
dataType	String	Data type search attribute
dataTypeIn	[String!]	Match any data types
dataId	String	Data ID search attribute
dataIdIn	[String!]	Match any data IDs

Assignment

Filter	Type	Description
assignee	String	Exact assignee match
assigneeIn	[String!]	Match any assignees
assigneeIsNil	Boolean	Unassigned workflows
assigneeNotNil	Boolean	Assigned workflows
groupBy	String	Group by value

Logical Operators

Filter	Type	Description
and	[WorkflowExecutionsWhereInput!]	All conditions must match
or	[WorkflowExecutionsWhereInput!]	Any condition matches
not	WorkflowExecutionsWhereInput	Negate condition

Ordering Options (WorkflowExecutionOrder)

Field	Values	Description
direction	ASC, DESC	Sort direction
field	START_TIME, CLOSE_TIME, WORKFLOW_ID, STATUS	Field to sort by

Usage Examples

Basic Query with Pagination

query {
  workflowExecutions(
    first: 50
    orderBy: { direction: DESC, field: START_TIME }
  ) {
    edges {
      node {
        execution {
          workflowId
          id
        }
        type {
          name
        }
        status
        startTime
        closeTime
      }
      cursor
    }
    pageInfo {
      hasNextPage
      endCursor
    }
    totalCount
  }
}

Filter by Status and Type

query {
  workflowExecutions(
    where: {
      typeName: "PickingWorkflow"
      status: "RUNNING"
    }
    first: 100
  ) {
    edges {
      node {
        execution {
          workflowId
          id
        }
        type {
          name
        }
        status
        startTime
        historyLength
        memo {
          title
          subtitle
        }
      }
    }
    totalCount
  }
}

Complex Filtering

query {
  workflowExecutions(
    where: {
      and: [
        { typeNameIn: ["PickingWorkflow", "ReceivingWorkflow"] }
        { statusNotIn: ["COMPLETED", "FAILED"] }
        { startTimeGTE: "2024-01-01T00:00:00Z" }
        { assigneeNotNil: true }
      ]
    }
    first: 50
    orderBy: { direction: ASC, field: START_TIME }
  ) {
    edges {
      node {
        execution {
          workflowId
        }
        status
        startTime
        memo {
          title
        }
        searchAttributes {
          key
          value
        }
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

Paginating Through Results

# First page
query FirstPage {
  workflowExecutions(
    where: { service: "picking" }
    first: 100
  ) {
    edges {
      node {
        execution { workflowId }
        status
      }
      cursor
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

# Next page (use endCursor from previous response)
query NextPage {
  workflowExecutions(
    where: { service: "picking" }
    first: 100
    after: "eyJzdGFydFRpbWUiOiIyMDI0LTAxLTE1VDEwOjMwOjAwWiJ9"
  ) {
    edges {
      node {
        execution { workflowId }
        status
      }
      cursor
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

Find Specific Workflow

query {
  workflowExecutions(
    where: {
      workflowID: "picking-order-12345"
    }
  ) {
    edges {
      node {
        execution {
          workflowId
          id
        }
        type {
          name
        }
        status
        startTime
        closeTime
        historyLength
        historySizeBytes
        taskQueue
        executionDuration
        memo {
          title
          subtitle
          data
        }
      }
    }
  }
}

Filter by Data Type and Service

query {
  workflowExecutions(
    where: {
      service: "picking"
      dataType: "picking-order"
    }
    first: 50
  ) {
    edges {
      node {
        execution {
          workflowId
        }
        status
        searchAttributes {
          key
          value
        }
      }
    }
  }
}

Example Response

{
  "data": {
    "workflowExecutions": {
      "edges": [
        {
          "node": {
            "execution": {
              "workflowId": "picking-order-12345",
              "id": "run-abc-123"
            },
            "type": {
              "name": "PickingWorkflow"
            },
            "status": "RUNNING",
            "startTime": "2024-01-15T10:30:00Z",
            "closeTime": null,
            "historyLength": 42,
            "memo": {
              "title": "Picking Order #12345",
              "subtitle": "Zone A"
            }
          },
          "cursor": "eyJzdGFydFRpbWUiOiIyMDI0LTAxLTE1VDEwOjMwOjAwWiJ9"
        }
      ],
      "pageInfo": {
        "hasNextPage": true,
        "endCursor": "eyJzdGFydFRpbWUiOiIyMDI0LTAxLTE1VDEwOjMwOjAwWiJ9"
      },
      "totalCount": 150
    }
  }
}

Breaking Changes

This query has undergone significant changes:

1. Return type changed from [WorkflowExecutionInfo!]! to WorkflowExecutionInfoConnection!

2. Pagination support added via first and after parameters

3. Ordering support added via orderBy parameter

4. History not included - use workflowHistory query for history events

See WorkflowExecutionInfo for migration examples.

Notes

• Returns lightweight execution metadata WITHOUT history for performance

• Use workflowHistory query to fetch history for specific executions

• Pagination uses Temporal's NextPageToken directly

• Default page size is 100 if first is not specified

• Results can be ordered by start time, close time, workflow ID, or status

Related Documentation

• workflowHistory - Fetch workflow history events

• WorkflowExecutionInfo - Execution info type

• WorkflowExecutionInfoConnection - Connection type

• WorkflowEvent - History event type