Workflows

Workflows Query

Returns a paginated list of Workflow objects, with optional filtering and ordering. Workflows represent business process definitions that can be executed by the Temporal workflow engine.

Arguments

Name
Type
Description

after

Cursor

Returns the elements in the list that come after the specified cursor

first

Int

Returns the first n elements from the list

before

Cursor

Returns the elements in the list that come before the specified cursor

last

Int

Returns the last n elements from the list

orderBy

WorkflowOrder

Ordering options for workflows returned from the connection

where

WorkflowWhereInput

Filtering options for workflows returned from the connection

Return Type

WorkflowConnection! - A connection to a list of Workflow objects with pagination information.

Notes

The data field contains custom workflow attributes as JSON. You can use the Data, DataHasKey, DataIn, and DataContains filters to query based on JSON content. For complex JSON field queries, see Advanced JSON Field Queries.

Usage Example

query {
  # Get active workflows
  workflows(
    where: {
      active: true
    },
    orderBy: { direction: DESC, field: CREATED_AT }
  ) {
    edges {
      node {
        id
        name
        active
        filterRule
        dataTypeSlug
        data
        createdAt
        workflowsignals {
          id
          eventName
          start
        }
      }
      cursor
    }
    totalCount
  }
}

Common Filters

  • nameContains - Search by workflow name substring

  • name - Find by exact workflow name

  • active - Filter by active status

  • dataTypeSlug - Filter by data type slug

  • filterRule - Filter by rule definition

  • tenantID - Filter by tenant

  • createdAtGTE / createdAtLTE - Filter by creation date range

Notes

  • Workflows define business process templates for execution

  • Integration with Temporal.io workflow engine for reliable execution

  • Active workflows are available for execution

  • Filter rules determine when workflows should be triggered

  • Workflow signals define the events that can start or control workflows

  • Support custom fields through data/dataType system

  • Essential for orchestrating complex business operations across services

Last updated

Was this helpful?