---
title: "Get Folders"
method: GET
path: "/folders"
tags: ["Folder"]
---

# Get Folders

`GET /folders`

Use this endpoint to retrieve the list of folders in the account with their workspaces.

## Query parameters

- `offset` integer
- `limit` integer
- `sort` string
- `filter[name]` string
- `filter[parent_ids]` string
- `filter[workspace_ids]` string

## Headers

- `x-oneflow-api-token` string, required
- `x-oneflow-user-email` string, email

## Response `200`

Returns the list of folders.

- object — A list of folders with their workspaces.
  - `_links` object — Links to related endpoints.
    - `comments` object
      - `href` string, nullable
    - `contracts` object
      - `href` string, nullable
    - `contract` object
      - `href` string, nullable
    - `create` object
      - `href` string, nullable
    - `data_field` object
      - `href` string, nullable
    - `data_fields` object
      - `href` string, nullable
    - `events` object
      - `href` string, nullable
    - `event` object
      - `href` string, nullable
    - `files` object
      - `href` string, nullable
    - `file` object
      - `href` string, nullable
    - `next` object
      - `href` string, nullable
    - `parties` object
      - `href` string, nullable
    - `party` object
      - `href` string, nullable
    - `previous` object
      - `href` string, nullable
    - `publish` object
      - `href` string, nullable
    - `self` object
      - `href` string, nullable
    - `template_types` object
      - `href` string, nullable
    - `template_type` object
      - `href` string, nullable
    - `template` object
      - `href` string, nullable
    - `templates` object
      - `href` string, nullable
    - `workspaces` object
      - `href` string, nullable
    - `workspace` object
      - `href` string, nullable
    - `playbooks` object
      - `href` string, nullable
  - `count` integer, required
  - `data` object[], required
    - `_permissions` object, required — This attribute contains the permissions for various operations possible on the folders.
      - `folder:contract` boolean, required
      - `folder:delete` boolean, required
      - `folder:sub_folder:create` boolean, required
      - `folder:update` boolean, required
    - `id` integer, required — Folder ID
    - `name` string, required — Folder name.
    - `parent_id` integer, nullable, required — If exist any parent folder, its ID.
    - `path` integer[], required — An array of folder IDs representing the path from the top of the hierarchy to the current folder.
    - `workspace_id` integer, required — workspace ID

## Other responses

- `400` — Invalid format or content of the request.
- `401` — The API token or the user email is invalid.
- `403` — The request is not authorized by the server.

---

[API](https://skmtc.net/oneflow/apis/public-api-for-oneflow.md) · [All operations](https://skmtc.net/oneflow/apis/public-api-for-oneflow/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/oneflow/public-api-for-oneflow/versions/0e73a45dec15/schema)