List folders in a project

GET

/api/v1/projects/{projectId}/folders

curl --request GET \
  --url 'https://api.yggy.tech/api/v1/projects/example/folders?archived=false' \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• bearerAuth
• apiKeyAuth

Parameters

Path Parameters

projectId

required

string

Query Parameters

parentFolderId

Parent folder externalId. Omit for top-level folders.

string

Parent folder externalId. Omit for top-level folders.

archived

string

default: false

Allowed values: false only

Responses

200

Folders

Media type application/json

object

folders

required

Array<object>

object

folderId

required

string

name

required

string

parentFolderId

required

string | null

projectExternalId

required

string

createdAt

required

string

updatedAt

required

string

deletedAt

string | null

childCount

number

documentCount

number

breadcrumbs

Array<object>

object

folderId

required

string

name

required

string

Example ^generated

{
  "folders": [
    {
      "folderId": "example",
      "name": "example",
      "parentFolderId": "example",
      "projectExternalId": "example",
      "createdAt": "example",
      "updatedAt": "example",
      "deletedAt": "example",
      "childCount": 1,
      "documentCount": 1
    }
  ],
  "breadcrumbs": [
    {
      "folderId": "example",
      "name": "example"
    }
  ]
}