GET All folders

get

https://app.plugsign.com.br/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

int32

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

name

string

Nome da pasta visível no sistema.

accessibility

string

enum

Visibilidade padrão da pasta.

Allowed:

per_page

integer

Defaults to 15

Define a quantidade de itens por página.

path

string

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

Body Params

include_sub_folders

boolean

Quando true, retorna as subpastas de cada pasta no resultado.

sub_folders_depth

string

enum

Defaults to 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

Allowed:

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

200200