---
title: "GET All folders"
method: GET
path: "/api/folders"
---

# GET All folders

`GET /api/folders`

Com este endpoint você pode listar todas as pastas ou pastas específicas na plataforma, lembrando que a API também vai retornar **subpastas** como objetos secundários.

É possível **filtrar os resultados** utilizando os query params disponíveis listados abaixo.

## Query parameters

- `id` integer
- `name` string
- `accessibility` 'Everyone' | 'Departments' | 'OnlyMe'
- `per_page` integer
- `path` string

## Request body

- object
  - `include_sub_folders` boolean — Quando true, retorna as subpastas de cada pasta no resultado.
  - `sub_folders_depth` '0' | '1' | '2' — Define até qual nível de profundidade as subpastas serão retornadas. 0 → Retorna somente a pasta principal (sem subpastas) 1 → Retorna a pasta principal + subpastas diretas 2 → Retorna a pasta principal + subpastas e sub-subpastas
  - `paginate_sub_folders` boolean — Quando true, as subpastas são retornadas de forma paginada, seguindo o mesmo padrão de paginação da listagem principal.

## Response `200`

200

- object
  - `data` object[] — Lista de pastas cadastradas.
    - `id` integer — Identificador único da pasta.
    - `folder` string — Nome da pasta.
    - `accessibility` 'Everyone' | 'Departments' | 'OnlyMe' — Visibilidade da pasta.
    - `created_on` string — Data e hora de criação da pasta.
    - `sub_folders` object[] — Lista de subpastas contidas na pasta.
      - `id` integer — Identificador único da pasta.
      - `folder` string — Nome da pasta.
      - `sub_folders` object[] — Lista de subpastas contidas na pasta.
      - `created_on` string — Data e hora de criação da pasta.
  - `links` object
    - `first` string — URL da primeira página.
    - `last` string — URL da última página.
    - `prev` string — URL da página anterior.
    - `next` string — URL da próxima página.
  - `meta` object
    - `current_page` integer — Página atual.
    - `from` integer — Primeiro item retornado na página atual.
    - `last_page` integer — Última página disponível.
    - `links` object[] — Lista de links de navegação da paginação.
      - `url` string — URL da página correspondente ao link de navegação.
      - `label` string — Texto exibido no link de paginação.
      - `active` boolean — Indica se este link representa a página atual.
    - `path` string — URL base da paginação.
    - `per_page` string — Quantidade de itens por página.
    - `to` integer — Último item retornado na página atual.
    - `total` integer — Total de registros disponíveis.

---

[API](https://skmtc.net/plugsign/apis/endpoints-manuais.md) · [All operations](https://skmtc.net/plugsign/apis/endpoints-manuais/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/plugsign/endpoints-manuais/versions/41e10c7c691b/schema)