Skip to main content

List directories

GET /projects/:projectid/library/dirs

The subdirectories of a library directory.

Lists the directories directly inside a directory, with a count of what each contains. Omit path for the library root.

Authentication​

  • Project API key: The credential for everything external. Created in Project Settings, bound to one project, and limited to the scopes it was granted. Format: proj.<keyId>.<secret>.
  • Required permission: library.read.

Path parameters​

NameTypeRequiredDefaultDescription
projectidstringYes-The project id.

Query parameters​

NameTypeRequiredDefaultDescription
pathstringNo-Directory path. Defaults to the root.

Example request​

curl -X GET \
-H "Authorization: proj.KEY_ID.SECRET" \
{{BASE_URL}}/projects/{{PROJECT_ID}}/library/dirs?path=invoices

Responses​

200​

The child directories.

{
"dirs": [
{
"id": "dir_2Bd9",
"name": "invoices",
"parent": "root",
"childrenCount": 3,
"docCount": 0
}
]
}

404​

No directory at that path.