Skip to content
Lexcel Docs

List Documents
GET
/v1/workspaces/{workspace_id}/documents

Return the workspace’s directory and file tree as a flat node list.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace_id
required
Workspace Id
integer

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

DocumentTreeResponse
object
workspace_id
required
Workspace Id
integer
workspace_name
required
Workspace Name
string
nodes
required
Nodes
Array<object>
DocumentTreeNode
object
id
required
Id

Directory id for directories, file id for files.

integer
name
required
Name
string
type
required
Type

“directory” or “file”.

string
parent_directory_id
Any of:
integer
file_id
Any of:
integer

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object