PLplugsign

GET All folders

Changed on

Com este endpoint você pode listar as pastas da empresa. Sem filtros (id, name ou path), a listagem traz apenas as pastas da raiz, com as subpastas aninhadas em sub_folders. Os filtros id, name (igualdade exata) e path localizam pastas em qualquer nível.

Todos os filtros são parâmetros de query. Um path inexistente responde 200 com data: []; barras invertidas no path precisam de URL-encode (%5C).

get/api/folders

Request

  • Base URL
    https://app.plugsign.com.br
  • URL
    https://app.plugsign.com.br/api/folders
  • Auth
    API key in header Authorization

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'

Filtra pela visibilidade. Usado sozinho, continua restrito às pastas da raiz.

per_pageinteger

Itens por página: mínimo 1, máximo 100 (acima disso a resposta é 422). Padrão: 15.

pathstring

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

include_sub_folders1 | 0

Quando 1, inclui as subpastas em sub_folders. Use 1 ou 0 (a string false responde 422).

sub_folders_depthinteger

Profundidade de subpastas, de 0 a 5 (acima de 5 responde 422). Atualmente o valor não altera o resultado: a árvore completa de subpastas é sempre retornada.

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
  }
}

Changes

  • 3db1513040eaRevision changes
    • breaking

      removed the request body

    • breaking

      for the query request parameter per_page, default value was changed from 15 to 15

    • breaking

      the / response's property type changed from string to integer for status

    • warning

      for the query request parameter per_page, the max was set to 100.00

    • warning

      for the query request parameter per_page, the min was set to 1.00

    • warning

      added the new Only Me enum value to the // response property for the response status

    • info

      added the new optional query request parameter include_sub_folders

    • info

      added the new optional query request parameter sub_folders_depth

    • info

      added the non-success response with the status

    • info

      added the optional property //// to the response with the status

    • info

      removed the OnlyMe enum value from the // response property for the response status