---
title: "Get Directory"
method: GET
path: "/workspaces/{workspace_id}/folders/directory"
tags: ["folders"]
---

# Get Directory

`GET /workspaces/{workspace_id}/folders/directory`

## Request

- Base URL: `https://platform.tracecat.com/api`
- URL: `https://platform.tracecat.com/api/workspaces/{workspace_id}/folders/directory`
- Auth: one of:
  - API key in cookie `fastapiusersauth`
  - HTTP bearer

Get directory items (workflows and folders) in the given path.

## Path parameters

- `workspace_id` string, uuid, required

## Query parameters

- `path` string: Folder path

## Response `200`

Successful Response

- union[]
  - union
    - WorkflowDirectoryItem
      - `id` string, required
      - `title` string, required
      - `description` string, required
      - `status` string, required
      - `icon_url` string, nullable, required
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
      - `version` integer, nullable, required
      - `tags` TagRead[], nullable
        - `id` string, uuid, required
        - `name` string, required
        - `ref` string, required: Slug-like identifier derived from name, used for API lookups
        - `color` string, nullable: Hex color code
      - `alias` string, nullable
      - `error_handler` string, nullable
      - `latest_definition` WorkflowDefinitionReadMinimal
        - `id` string, uuid, required
        - `version` integer, required
        - `created_at` string, date-time, required
      - `folder_id` string, uuid, nullable
      - `trigger_summary` WorkflowTriggerSummary
        - `schedule_count_online` integer
        - `schedule_cron` string, nullable
        - `schedule_natural` string, nullable
        - `webhook_active` boolean
        - `case_trigger_events` CaseEventType[]
      - `type` 'workflow', required
    - FolderDirectoryItem
      - `id` string, uuid, required
      - `name` string, required
      - `path` string, required
      - `workspace_id` string, uuid, required
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
      - `type` 'folder', required
      - `num_items` integer, required
      - `num_workflows` integer, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/tracecat/apis/tracecat-api.md) - [All operations](https://skmtc.dev/tracecat/apis/tracecat-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tracecat/apis/tracecat-api/revisions/2efdda25045f?raw)
