Skip to content

Get Project Folders

GET
/api/creative/visual-studio/projects/{project_id}/folders

Get all folders for a project.

project_id
required
Project Id
string

Successful Response

VisualFolderListResponse

Response model for listing folders.

object
folders
Folders

Folders

Array<object>
VisualFolder

Visual folder model for organizing assets within a project.

object
id
required
Id

Folder ID

string
projectId
required
Projectid

Project ID

string
name
required
Name

Folder name

string
color
Color

Folder color hex

string
""
parentId
Any of:
string
folderType
VisualFolderType

Folder type

string
default: standard
Allowed values: standard book-covers character-portraits location-art concept-art
createdAt
required
Createdat

Creation timestamp

integer
updatedAt
required
Updatedat

Last update timestamp

integer
total
Total

Total folder count

integer
0

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