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

# Get Workflows

> Get workflow details. If id or name is provided, returns a single workflow object. Otherwise, lists workflows (filtered by type — defaults to HTTP — and folderId) with cursor-based pagination.



## OpenAPI

````yaml /public-apis/openapi/workflows.json get /v1/workflows
openapi: 3.0.0
info:
  version: 1.0.0
  contact:
    name: Maxim Engineering
    email: eng@getmaxim.ai
  title: Maxim SDK API - workflows
  description: API documentation for Maxim SDK workflows endpoints
servers:
  - url: https://api.getmaxim.ai
security: []
paths:
  /v1/workflows:
    get:
      tags:
        - Workflow
      summary: Get Workflows
      description: >-
        Get workflow details. If id or name is provided, returns a single
        workflow object. Otherwise, lists workflows (filtered by type — defaults
        to HTTP — and folderId) with cursor-based pagination.
      parameters:
        - schema:
            type: string
            description: Unique identifier for the workspace
          required: true
          name: workspaceId
          in: query
        - schema:
            type: string
            description: Unique identifier of a specific workflow to fetch
          required: false
          name: id
          in: query
        - schema:
            type: string
            description: Name of a specific workflow to fetch
          required: false
          name: name
          in: query
        - schema:
            type: string
            description: >-
              Filter workflows by folder. Omit (with ignoreFolders=false) to
              list root-level workflows.
          required: false
          name: folderId
          in: query
        - schema:
            type: string
            enum:
              - HTTP
              - VOICE
            default: HTTP
            description: >-
              Workflow type filter. Defaults to HTTP; pass VOICE to list voice
              workflows.
          required: false
          name: type
          in: query
        - schema:
            type: boolean
            nullable: true
            default: false
            description: >-
              When true, include workflows from all folders instead of only
              root-level ones.
          required: false
          name: ignoreFolders
          in: query
        - schema:
            type: number
            nullable: true
            maximum: 100
            default: 10
            description: 'Maximum number of records to return (max: 100)'
          required: false
          name: limit
          in: query
        - schema:
            type: string
            description: Pagination cursor (id of the last item from the previous page)
          required: false
          name: cursor
          in: query
      responses:
        '200':
          description: Workflows retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    anyOf:
                      - $ref: '#/components/schemas/Workflow'
                      - type: array
                        items:
                          $ref: '#/components/schemas/Workflow'
                    description: Single Workflow if fetching by id/name, array otherwise.
                  pagination:
                    type: object
                    properties:
                      hasMore:
                        type: boolean
                      cursor:
                        type: string
                        nullable: true
                    required:
                      - hasMore
                      - cursor
                required:
                  - data
        '400':
          description: Invalid request parameters
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Workflow not found
      security:
        - ApiKeyAuth: []
components:
  schemas:
    Workflow:
      type: object
      properties:
        id:
          type: string
        workspaceId:
          type: string
        accountId:
          type: string
        name:
          type: string
        description:
          type: string
          nullable: true
        type:
          type: string
          enum:
            - HTTP
            - VOICE
        folderId:
          type: string
        config:
          nullable: true
        createdAt:
          type: string
        updatedAt:
          type: string
      required:
        - id
        - workspaceId
        - accountId
        - name
        - type
        - createdAt
        - updatedAt
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-maxim-api-key
      description: API key for authentication

````