GET All folders

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).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32

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

string

Nome da pasta visível no sistema.

string
enum

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

Allowed:
integer
1 to 100
Defaults to 15

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

string

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

integer
enum

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

Allowed:
integer
0 to 5

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.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json