---
title: "List folders"
method: GET
path: "/workspaces/{workspace_id}/projects/{project_id}/folders"
tags: ["Folders"]
---

# List folders

`GET /workspaces/{workspace_id}/projects/{project_id}/folders`

## Request

- Base URL: `https://app.mammoth.io/api/v2`
- URL: `https://app.mammoth.io/api/v2/workspaces/{workspace_id}/projects/{project_id}/folders`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-KEY` and API key in header `X-API-SECRET` and API key in header `X-WORKSPACE-ID`

List folders.

## Path parameters

- `workspace_id` integer, required: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
- `project_id` integer, required: Project ID of the workspace

## Query parameters

- `fields` string, nullable: Fields to be returned in a comma-separated format may include id, name, status_info, created_at.
- `id` string: Filter by multiple folder ids, comma separated
- `name` string, nullable: Filter by multiple folder names, comma separated
- `status` string, nullable: Filter by multiple folder statuses, comma separated
- `created_at` string, nullable: Filter by multiple folders, which falls under created_at date range
- `updated_at` string, nullable: Filter by multiple folders, which falls under updated_at date range
- `created_by` string, nullable: Filter by multiple folder created by user names, comma separated
- `limit` integer: Max number of result to return
- `offset` integer: Distance from the beginning of the list of results
- `sort` string, nullable: Sort the folders based on the fields

## Response `200`

List folders

- FoldersList
  - `folders` FolderSchema[], required
    - `id` integer, nullable: Folder Id
    - `name` string, nullable: Folder Name
    - `status` string, nullable: Status
    - `created_at` string, date-time, nullable: Created At
    - `updated_at` string, date-time, nullable: Updated At
    - `resource_id` integer, nullable: Resource id
    - `created_by` string, nullable: Created By
    - `parent_id` string, nullable: Parent Id
    - `resource_path` string, nullable: Resource Path
  - `offset` integer
  - `limit` integer
  - `next` string, required: URI for next page of data

## Other responses

- `400`: Bad Request
- `401`: Authorization error

---

[API](https://skmtc.dev/mammoth/apis/mammoth-analytics.md) · [All operations](https://skmtc.dev/mammoth/apis/mammoth-analytics/llms.txt) · [OpenAPI document](https://skmtc.dev/mammoth/apis/mammoth-analytics/revisions/5dfd1c296ded?raw)