> For the complete documentation index, see [llms.txt](https://docs.pyck.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pyck.cloud/graphql-api/queries/workflows.md).

# 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](https://github.com/pyck-ai/docs/blob/main/graphql/advanced/json-field-queries.md).

## Usage Example

```graphql
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
  }
}
```

```graphql
query {
  # Search workflows by name
  workflows(
    where: {
      nameContains: "picking"
    },
    first: 20
  ) {
    edges {
      node {
        id
        name
        active
        filterRule
        dataTypeSlug
        data
        workflowsignals {
          id
          eventName
          start
          data
        }
      }
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
  }
}
```

```graphql
query {
  # Get workflows with specific data type
  workflows(
    where: {
      dataTypeSlug: "order_processing"
    }
  ) {
    edges {
      node {
        id
        name
        active
        filterRule
        data
        workflowsignals {
          id
          eventName
          start
          createdAt
        }
      }
    }
  }
}
```

## 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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.pyck.cloud/graphql-api/queries/workflows.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.