> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ingestly.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List workflows

> Returns the workflows of the key's environment, ordered by name. `holds` is true when documents sent to the workflow's API trigger wait as `held` until a person runs them. `page` starts at 1; `pageSize` defaults to 20, at most 100.

Requires the `workflows:read` [scope](/api-reference/authentication#scopes). Returns the workflows of the key's [environment](/api-reference/authentication#environments-and-workspaces) across every workspace, ordered by name. Use `holds` to tell which workflows hold triggered documents instead of running them.


## OpenAPI

````yaml GET /workflows
openapi: 3.1.1
info:
  title: Ingestly API
  description: >-
    Public Ingestly API. Authenticate every request with an API key in the
    `X-Api-Key` header. A key belongs to one organization and carries scopes
    (such as `workflows:trigger` or `runs:read`); each operation requires one
    scope, and a key without it is rejected with 403. Errors use RFC 7807
    problem details.
  version: 1.0.0
servers:
  - url: https://api.ingestly.ai
security:
  - ApiKey: []
tags:
  - name: Workflows
  - name: Runs
  - name: Review Tasks
  - name: Events
  - name: Documents
paths:
  /workflows:
    get:
      tags:
        - Workflows
      summary: List workflows
      description: >-
        Returns the workflows of the key's environment, ordered by name. `holds`
        is true when documents sent to the workflow's API trigger wait as `held`
        until a person runs them. `page` starts at 1; `pageSize` defaults to 20,
        at most 100.
      operationId: listWorkflows
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            format: int32
        - name: pageSize
          in: query
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: OK
          headers:
            X-Correlation-ID:
              description: >-
                Server-generated request identifier. Quote it when contacting
                support.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedResponseOfGetWorkflowsResponse'
        '400':
          description: >-
            Bad Request. `page` is less than 1 or too large, or `pageSize` is
            not between 1 and 100.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetailResponse'
        '401':
          description: >-
            Unauthorized. The API key is missing, invalid, expired or
            deactivated.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetailResponse'
        '403':
          description: >-
            Forbidden. The API key lacks the `workflows:read` scope, or the plan
            does not include API access.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetailResponse'
        '429':
          description: >-
            Too Many Requests. The plan's rate limit was exceeded; retry after
            the seconds in Retry-After.
          headers:
            Retry-After:
              description: Seconds until the rate limit window resets.
              schema:
                type: integer
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetailResponse'
        '500':
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetailResponse'
components:
  schemas:
    PagedResponseOfGetWorkflowsResponse:
      required:
        - count
        - pages
        - data
      type: object
      properties:
        count:
          type: integer
          format: int32
        pages:
          type: integer
          format: int32
        data:
          type: array
          items:
            $ref: '#/components/schemas/GetWorkflowsResponse'
    ProblemDetailResponse:
      required:
        - status
        - title
        - type
        - instance
        - traceId
      type: object
      properties:
        status:
          type: integer
          format: int32
        title:
          type: string
        type:
          type: string
        instance:
          type: string
        traceId:
          type: string
        detail:
          type:
            - 'null'
            - string
        errors:
          type:
            - 'null'
            - object
          additionalProperties:
            type: array
            items:
              type: string
    GetWorkflowsResponse:
      required:
        - id
        - name
        - environment
        - isEnabled
        - holds
        - createdOn
      type: object
      properties:
        id:
          examples:
            - 0199a6c1-9e2f-7c3d-8a4b-1c2d3e4f5a6b
          type: string
          format: uuid
        name:
          examples:
            - Purchase orders
          type: string
        environment:
          examples:
            - prod
          enum:
            - dev
            - prod
          type: string
        isEnabled:
          examples:
            - true
          type: boolean
        holds:
          examples:
            - false
          type: boolean
        createdOn:
          examples:
            - '2026-09-14T09:12:44+00:00'
          type: string
          format: date-time
  securitySchemes:
    ApiKey:
      type: apiKey
      name: X-Api-Key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.