Sign in

v1

latestOpenAPI 3.1.02026-08-041060342.7 KB

GET All 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.

get/api/folders

Query parameters

idinteger

Id da pasta no sistema, pode ser obtido com o list folders geral (Sem filtros).

namestring

Nome da pasta visível no sistema.

accessibility'Everyone' | 'Departments' | 'OnlyMe'

Visibilidade padrão da pasta.

per_pageinteger

Define a quantidade de itens por página.

pathstring

Permite buscar uma pasta específica informando o caminho completo da hierarquia. Ex: /api/folders?path=\Agendamentos\Retirada\OSN1

Request body

include_sub_foldersboolean

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_foldersboolean

Quando true, as subpastas são retornadas de forma paginada, seguindo o mesmo padrão de paginação da listagem principal.

Response

200

Example response

{
  "data": [
    {
      "id": 1,
      "folder": "public_folder",
      "accessibility": "Everyone",
      "created_on": "26/11/2024 14:24:25"
    }
  ],
  "links": {
    "first": "/?page=1",
    "last": "/?page=1"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "label": "« Previous"
      }
    ],
    "path": "/",
    "per_page": "15",
    "to": 2,
    "total": 2
  }
}