Skip to main content
GET
/
api
/
documents
/
assistant
/
folders
Get all folders
curl --request GET \
  --url https://api.example.com/api/documents/assistant/folders \
  --header 'x-api-key: <x-api-key>'
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Product Documentation",
    "icon": "📚",
    "sort_order": 0,
    "created_at": "2024-01-15T10:00:00.000Z",
    "documents": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "subfolders": [
      {}
    ]
  }
]

Headers

x-api-key
string
required

API key needed to authorize the request

Response

Folders retrieved successfully.

id
string
Example:

"550e8400-e29b-41d4-a716-446655440000"

name
string
Example:

"Product Documentation"

icon
string
Example:

"📚"

sort_order
number
Example:

0

created_at
string
Example:

"2024-01-15T10:00:00.000Z"

documents
object[]
subfolders
object[]