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

# List folders

> Returns the workflow folders the caller's credential is scoped to. An API key pinned to a workspace
and environment lists that scope only; an account-level token lists every folder in the account.
Each folder carries its workspaceId and environmentId, since folder names are unique
only within one workspace + environment.
            
Every folder carries a type naming the kind of item it holds. Only workflow folders are
listed today; table folders will be added to the same list.
            
itemsCount counts the folder's items the caller can see; with role-based access control on,
that is the workflows they were granted plus public ones. Pass a workflow folder's id as
folderId to GET /v1/workflows to list them. For an API key pinned to a workspace that list
applies the same grants; for other callers it does not apply role-based access control yet, so
with it on the count can be lower than the list.
            
There is no workspace-level permission check on this list yet: folders are listed for any
authenticated caller within the credential's scope. Role-based access control only narrows the
counts; it does not hide folders or protect the items.



## OpenAPI

````yaml /developers/api-reference/openapi.json get /v1/folders
openapi: 3.0.0
info:
  title: Engini API
  version: v1
  description: The Engini public API.
servers:
  - url: https://api.engini.io
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Auth
    description: Identify the caller a Developer API request is authenticated as.
  - name: On-prem agents
    description: >-
      Provision and manage agents that run Engini tasks inside a customer's
      network.
  - name: Applications
    description: >-
      Discover the applications (toolkits) available in Engini and their
      connection requirements.
  - name: Tools
    description: Browse and execute the tools exposed by Engini applications.
  - name: Toolsets
    description: Manage toolsets - named groupings of connections and tools.
  - name: McpServers
    description: >-
      Inspect and maintain MCP servers - the account-wide endpoints that expose
      Engini tools and workflows over the Model Context Protocol. Distinct from
      the MCPClient connection kind, which is Engini consuming a third-party MCP
      server.
  - name: Connections
    description: >-
      Manage connections to applications, including OAuth sign-in and
      default-connection selection.
  - name: Folders
    description: >-
      List the folders that organize workflows in each workspace and
      environment.
  - name: Workflows
    description: >-
      List workflows, and build them from a plan: search the catalog, read
      schemas and options, compile, create and update.
  - name: Executions
    description: >-
      Read execution history for workflows, table automations and app business
      rules, including per-step logs and recorded payloads.
  - name: Triggers
    description: >-
      Create triggers that fire when something changes in a connected app, and
      manage the destinations their events are delivered to.
paths:
  /v1/folders:
    get:
      tags:
        - Folders
      summary: List folders
      description: >-
        Returns the workflow folders the caller's credential is scoped to. An
        API key pinned to a workspace

        and environment lists that scope only; an account-level token lists
        every folder in the account.

        Each folder carries its workspaceId and environmentId, since folder
        names are unique

        only within one workspace + environment.
                    
        Every folder carries a type naming the kind of item it holds. Only
        workflow folders are

        listed today; table folders will be added to the same list.
                    
        itemsCount counts the folder's items the caller can see; with role-based
        access control on,

        that is the workflows they were granted plus public ones. Pass a
        workflow folder's id as

        folderId to GET /v1/workflows to list them. For an API key pinned to a
        workspace that list

        applies the same grants; for other callers it does not apply role-based
        access control yet, so

        with it on the count can be lower than the list.
                    
        There is no workspace-level permission check on this list yet: folders
        are listed for any

        authenticated caller within the credential's scope. Role-based access
        control only narrows the

        counts; it does not hide folders or protect the items.
      operationId: Folders_ListFolders
      parameters:
        - name: name
          in: query
          description: Optional substring match on the folder name.
          schema:
            type: string
            nullable: true
          x-position: 1
        - name: type
          in: query
          description: >-
            Optional folder kind: workflow or table, case-insensitive. Omitted
            lists every kind. table answers 501 until table folders are served.
          schema:
            type: string
            nullable: true
          x-position: 2
        - name: sort
          in: query
          description: >-
            Optional sort over name, createdAt. Comma-separated keys, each
            "field asc" or "field desc", highest priority first - e.g.
            "createdAt desc,name asc". At most 3 keys; a field may appear once;
            every key needs an explicit direction when there is more than one. A
            single key may omit the direction and then sorts ascending. Defaults
            to name asc.
          schema:
            type: string
            nullable: true
          x-position: 3
        - name: offset
          in: query
          description: Zero-based index of the first item to return. Defaults to 0.
          schema:
            type: integer
            format: int32
            default: 0
          x-position: 4
        - name: top
          in: query
          description: Maximum number of items to return, capped at 100. Defaults to 100.
          schema:
            type: integer
            format: int32
            default: 100
          x-position: 5
      responses:
        '200':
          description: A paginated list of folders.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponseOfFolderPublicDTO'
        '400':
          description: Bad request - malformed body or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized - missing or invalid bearer token or API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden - the caller lacks access to the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found - the resource does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too many requests - rate limit exceeded.
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error - an unexpected error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '501':
          description: >-
            Not implemented - type=table is accepted but table folders are not
            served yet.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - Bearer: []
        - ApiKey: []
      x-codeSamples:
        - lang: python
          label: Python
          source: |-
            from engini import Engini

            client = Engini()  # reads ENGINI_API_KEY

            # workflow folders; name is a case-insensitive substring match
            folders = client.folders.list(name="sales")
        - lang: typescript
          label: TypeScript
          source: |-
            import { Engini } from "@engini/sdk";

            const client = new Engini(); // reads ENGINI_API_KEY

            // workflow folders; name is a case-insensitive substring match
            const folders = await client.folders.list({ name: "sales" });
        - lang: bash
          label: CLI
          source: engini workflows folders --name sales
components:
  schemas:
    PaginatedResponseOfFolderPublicDTO:
      type: object
      description: Offset-based paginated wrapper for a list of items.
      additionalProperties: false
      required:
        - items
        - totalCount
        - offset
        - top
      properties:
        items:
          type: array
          description: The items in the current page.
          items:
            $ref: '#/components/schemas/FolderPublicDTO'
        totalCount:
          type: integer
          description: Total number of items available across all pages.
          format: int32
        offset:
          type: integer
          description: Number of items skipped before this page (the requested offset).
          format: int32
        top:
          type: integer
          description: Maximum number of items requested for this page.
          format: int32
    ErrorResponse:
      type: object
      description: >-
        Unified machine-readable error envelope returned by every non-200
        Developer API response.
      additionalProperties: false
      required:
        - errorCode
        - message
        - requestId
        - timestamp
      properties:
        errorCode:
          type: string
          description: Machine-readable error code identifying the failure.
        message:
          type: string
          description: Human-readable error message.
        requestId:
          type: string
          description: Identifier of the request, for support/correlation.
        timestamp:
          type: string
          description: Timestamp when the error occurred (ISO 8601).
        details:
          type: array
          description: Per-field validation details, when applicable.
          nullable: true
          items:
            $ref: '#/components/schemas/ErrorDetail'
    FolderPublicDTO:
      type: object
      description: >-
        Public shape of a folder, as returned by GET /v1/folders. Folders are
        flat (no nesting),

        belong to one workspace + environment, and hold one kind of item - see
        Type.
      additionalProperties: false
      required:
        - id
        - type
        - name
        - itemsCount
        - workspaceId
        - environmentId
        - createdAt
      properties:
        id:
          type: string
          description: >-
            Identifier of the folder, unique across folder types. A string
            because folder kinds use

            different id formats. Pass a workflow folder's id as folderId to GET
            /v1/workflows.
        type:
          type: string
          description: >-
            The kind of item the folder holds: workflow (the only kind today) or
            table.
        name:
          type: string
          description: >-
            Display name of the folder. Unique only within its workspace +
            environment.
        position:
          type: integer
          description: >-
            The folder's position in the designer's folder list; omitted for
            folder types that have none.
          format: int32
          nullable: true
        itemsCount:
          type: integer
          description: >-
            Number of non-deleted items in the folder that the caller can see.
            With role-based access control on,

            only items the caller was granted plus public ones are counted, so
            this can differ from the

            GET /v1/workflows?folderId={id} list until that endpoint applies
            role-based access control too.
          format: int32
        workspaceId:
          type: string
          description: The workspace the folder belongs to.
          format: uuid
        environmentId:
          type: string
          description: The environment (of WorkspaceId) the folder belongs to.
          format: uuid
        workspace:
          description: >-
            The workspace the folder belongs to; omitted for a row that predates
            workspaces. Carries the same ids as WorkspaceId and EnvironmentId,
            with the names added.
          nullable: true
          oneOf:
            - $ref: '#/components/schemas/WorkspaceRefPublicDTO'
        environment:
          description: >-
            The environment (of Workspace) the folder belongs to; omitted for a
            row that predates workspaces.
          nullable: true
          oneOf:
            - $ref: '#/components/schemas/EnvironmentRefPublicDTO'
        createdAt:
          type: string
          description: When the folder was created (UTC).
          format: date-time
        updatedAt:
          type: string
          description: >-
            When the folder was last renamed or moved (UTC); omitted when it
            never was.
          format: date-time
          nullable: true
    ErrorDetail:
      type: object
      description: A single field-level error detail within an ErrorResponse.
      additionalProperties: false
      required:
        - field
        - issue
      properties:
        field:
          type: string
          description: Name of the field the issue relates to.
        issue:
          type: string
          description: Description of the issue with the field.
    WorkspaceRefPublicDTO:
      type: object
      description: >-
        The workspace a /v1 item belongs to, as it appears in the item's
        workspace member.
      additionalProperties: false
      required:
        - id
      properties:
        id:
          type: string
          description: Identifier of the workspace.
          format: uuid
        name:
          type: string
          description: >-
            Display name of the workspace; null for an API key, for a workspace
            the caller cannot open, and when the name could not be read.
          nullable: true
    EnvironmentRefPublicDTO:
      type: object
      description: >-
        The environment a /v1 item belongs to, as it appears in the item's
        environment member. Same rules as

        WorkspaceRefPublicDTO: Name and Type are null whenever the name is.
      additionalProperties: false
      required:
        - id
      properties:
        id:
          type: string
          description: Identifier of the environment.
          format: uuid
        name:
          type: string
          description: >-
            Display name of the environment; null when the caller cannot be
            shown it.
          nullable: true
        type:
          type: string
          description: >-
            Kind of environment: Production, Staging or Development; null when
            the name is.
          nullable: true
  securitySchemes:
    Bearer:
      type: http
      description: Enter your JWT token
      scheme: bearer
      bearerFormat: JWT
    ApiKey:
      type: apiKey
      description: >-
        Opaque Developer API key (prefix `eng_`). Authenticates as the key's
        owner and resolves the account automatically.
      name: x-api-key
      in: header

````

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