Get folders

Get folders

Query Parameters

parentFolderId string

The parent folder ID to filter folders by. Null filters to root folder. Absent will return all folders.

Responses

• 200

---

Folders retrieved successfully

application/json

application/json; charset=utf-8

Schema

Example (from schema)

---

Schema

data object[] required
Array [
id uuid required
The ID of the folder
createdAt float required
Timestamp in seconds since the UNIX epoch. Can be transformed into a Date object.
updatedAt float required
Timestamp in seconds since the UNIX epoch. Can be transformed into a Date object.
name string required
The name of the folder
organizationId uuid required
The ID of the organization that owns the folder
parentFolderId uuid nullable required
The ID of the parent folder
]

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": 0,
      "updatedAt": 0,
      "name": "string",
      "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "parentFolderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

Schema

Example (from schema)

---

Schema

data object[] required
Array [
id uuid required
The ID of the folder
createdAt float required
Timestamp in seconds since the UNIX epoch. Can be transformed into a Date object.
updatedAt float required
Timestamp in seconds since the UNIX epoch. Can be transformed into a Date object.
name string required
The name of the folder
organizationId uuid required
The ID of the organization that owns the folder
parentFolderId uuid nullable required
The ID of the parent folder
]

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": 0,
      "updatedAt": 0,
      "name": "string",
      "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "parentFolderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

Loading...