List a project's folder hierarchy

GET

/api/v1/documents/folders

const url = 'https://app.avera.io/api/v1/documents/folders';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://app.avera.io/api/v1/documents/folders

Returns a flat list of folders with parent references and document counts, for building the sidebar tree. Which item types act as folders is declared in the meta-model, so a project in which no type declares a folder has none.

Parameters

Query Parameters

projectId

string format: uuid

Responses

200

*/*

Array<object>

object

required

string format: uuid

name

required

string

parentFolderId

string | null format: uuid

sortOrder

required

integer format: int32

documentCount

required

integer format: int64