docs
CTRL K
GitHubDiscord
DevelopersAPI ReferenceLearnIntegrationsWebsiteGitHubDiscord
Skip to Content

Folders

Content folders used to organize and group courses (collections).

Create folder

POST/api/v1/folders/
API tokenfolders:createor user session

Create a new folder (optionally nested under a parent folder) within an organization.

Request bodyapplication/jsonrequired

namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
org_idinteger
parent_folder_uuidstring | null

Returns

FolderRead — Successful Response

namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
Show child attributes
namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
Show child attributes
namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
Show child attributes
namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
itemsFolderContentItem[]
breadcrumbsFolderBreadcrumb[]
itemsFolderContentItem[]
Show child attributes
resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
breadcrumbsFolderBreadcrumb[]
Show child attributes
folder_uuidstringrequired
namestringrequired
itemsFolderContentItem[]
Show child attributes
resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
breadcrumbsFolderBreadcrumb[]
Show child attributes
folder_uuidstringrequired
namestringrequired
itemsFolderContentItem[]
Show child attributes
resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
breadcrumbsFolderBreadcrumb[]
Show child attributes
folder_uuidstringrequired
namestringrequired
Error responses
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "name": "Example name",
  "public": true,
  "description": "An example description",
  "thumbnail_image": "string",
  "color": "#0a0a0a",
  "id": 1,
  "org_id": 1,
  "folder_uuid": "string",
  "parent_folder_id": 1,
  "order": 0,
  "creation_date": "string",
  "update_date": "string",
  "total_items": 0,
  "subfolders": [],
  "items": [],
  "breadcrumbs": []
}

Get folder

GET/api/v1/folders/{folder_uuid}
API tokenfolders:reador user session

Get a single folder by its UUID, including its sub-folders, items and breadcrumbs.

Path parameters

folder_uuidstringrequired

Returns

FolderRead — Successful Response

namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
Show child attributes
namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
Show child attributes
namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
Show child attributes
namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
itemsFolderContentItem[]
breadcrumbsFolderBreadcrumb[]
itemsFolderContentItem[]
Show child attributes
resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
breadcrumbsFolderBreadcrumb[]
Show child attributes
folder_uuidstringrequired
namestringrequired
itemsFolderContentItem[]
Show child attributes
resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
breadcrumbsFolderBreadcrumb[]
Show child attributes
folder_uuidstringrequired
namestringrequired
itemsFolderContentItem[]
Show child attributes
resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
breadcrumbsFolderBreadcrumb[]
Show child attributes
folder_uuidstringrequired
namestringrequired
Error responses
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "name": "Example name",
  "public": true,
  "description": "An example description",
  "thumbnail_image": "string",
  "color": "#0a0a0a",
  "id": 1,
  "org_id": 1,
  "folder_uuid": "string",
  "parent_folder_id": 1,
  "order": 0,
  "creation_date": "string",
  "update_date": "string",
  "total_items": 0,
  "subfolders": [],
  "items": [],
  "breadcrumbs": []
}

Update folder

PUT/api/v1/folders/{folder_uuid}
API tokenfolders:updateor user session

Update a folder by its UUID. Pass `parent_folder_uuid` to move it (use empty/'root' to move to root).

Path parameters

folder_uuidstringrequired

Request bodyapplication/jsonrequired

namestring | null
publicboolean | null
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
parent_folder_uuidstring | null

Returns

FolderRead — Successful Response

namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
Show child attributes
namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
Show child attributes
namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
Show child attributes
namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
itemsFolderContentItem[]
breadcrumbsFolderBreadcrumb[]
itemsFolderContentItem[]
Show child attributes
resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
breadcrumbsFolderBreadcrumb[]
Show child attributes
folder_uuidstringrequired
namestringrequired
itemsFolderContentItem[]
Show child attributes
resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
breadcrumbsFolderBreadcrumb[]
Show child attributes
folder_uuidstringrequired
namestringrequired
itemsFolderContentItem[]
Show child attributes
resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
breadcrumbsFolderBreadcrumb[]
Show child attributes
folder_uuidstringrequired
namestringrequired
Error responses
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "name": "Example name",
  "public": true,
  "description": "An example description",
  "thumbnail_image": "string",
  "color": "#0a0a0a",
  "id": 1,
  "org_id": 1,
  "folder_uuid": "string",
  "parent_folder_id": 1,
  "order": 0,
  "creation_date": "string",
  "update_date": "string",
  "total_items": 0,
  "subfolders": [],
  "items": [],
  "breadcrumbs": []
}

Delete folder

DELETE/api/v1/folders/{folder_uuid}
API tokenfolders:deleteor user session

Delete a folder by its UUID. Sub-folders and item placements are removed with it.

Path parameters

folder_uuidstringrequired
Error responses
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

List folders for org

GET/api/v1/folders/org/{org_id}/page/{page}/limit/{limit}
API tokenfolders:reador user session

List folders for an organization. By default lists root folders; pass `parent_folder_uuid` to list a folder's direct sub-folders.

Path parameters

pageintegerrequired
limitintegerrequired
org_idstringrequired

Query parameters

parent_folder_uuidstring | null

Returns

FolderRead[] — Successful Response

namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
Show child attributes
namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
Show child attributes
namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
Show child attributes
namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
itemsFolderContentItem[]
breadcrumbsFolderBreadcrumb[]
itemsFolderContentItem[]
Show child attributes
resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
breadcrumbsFolderBreadcrumb[]
Show child attributes
folder_uuidstringrequired
namestringrequired
itemsFolderContentItem[]
Show child attributes
resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
breadcrumbsFolderBreadcrumb[]
Show child attributes
folder_uuidstringrequired
namestringrequired
itemsFolderContentItem[]
Show child attributes
resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
breadcrumbsFolderBreadcrumb[]
Show child attributes
folder_uuidstringrequired
namestringrequired
Error responses
  • 422 Validation Error — HTTPValidationError
Request
Response
[
  {
    "name": "Example name",
    "public": true,
    "description": "An example description",
    "thumbnail_image": "string",
    "color": "#0a0a0a",
    "id": 1,
    "org_id": 1,
    "folder_uuid": "string",
    "parent_folder_id": 1,
    "order": 0,
    "creation_date": "string",
    "update_date": "string",
    "total_items": 0,
    "subfolders": [],
    "items": [],
    "breadcrumbs": []
  }
]
GET/api/v1/folders/org/{org_id}/search
API tokenfolders:reador user session

Search folders and content across the whole library tree; each result includes its folder-path context.

Path parameters

org_idstringrequired

Query parameters

qstringrequired
Error responses
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Reorder library folders

PUT/api/v1/folders/org/{org_id}/order
API tokenfolders:updateor user session

Persist the manual (admin drag) ordering of sibling folders. Reorders root folders by default; pass `parent_folder_uuid` to reorder a folder's direct sub-folders. Admin only.

Path parameters

org_idintegerrequired

Query parameters

parent_folder_uuidstring | null

Request bodyapplication/jsonrequired

folder_order_by_idsFolderOrder[]required
Show child attributes
folder_idintegerrequired
Error responses
  • 400 A folder id is not in the org/parent scope
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization or parent folder not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Reorder a folder's content items

PUT/api/v1/folders/{folder_uuid}/content/order
API tokenfolders:updateor user session

Persist the manual (admin drag) ordering of a folder's content (courses, media, …). Position is derived from the array index. Admin only.

Path parameters

folder_uuidstringrequired

Request bodyapplication/jsonrequired

resource_uuidsstring[]required
Error responses
  • 400 A resource is not in this folder
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Folder or organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

List org library root items

GET/api/v1/folders/org/{org_id}/root
API tokenfolders:reador user session

List the items placed directly at the organization library root (not inside any folder).

Path parameters

org_idstringrequired

Returns

FolderContentItem[] — Successful Response

resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
Error responses
  • 422 Validation Error — HTTPValidationError
Request
Response
[
  {
    "resource_uuid": "string",
    "resource_type": "string",
    "position": 0,
    "resource": {}
  }
]

Add content to library root

POST/api/v1/folders/org/{org_id}/content
API tokenfolders:createor user session

Place a resource directly at the organization library root (Drive-like).

Path parameters

org_idintegerrequired

Query parameters

resource_uuidstringrequired
positioninteger
Error responses
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Remove content from library root

DELETE/api/v1/folders/org/{org_id}/content
API tokenfolders:deleteor user session

Remove a resource placement from the organization library root.

Path parameters

org_idintegerrequired

Query parameters

resource_uuidstringrequired
Error responses
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Upload folder cover image

PUT/api/v1/folders/{folder_uuid}/thumbnail
API tokenfolders:updateor user session

Upload a cover image (thumbnail) for a folder.

Path parameters

folder_uuidstringrequired

Request bodymultipart/form-datarequired

thumbnailfilerequired

Returns

FolderRead — Successful Response

namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
Show child attributes
namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
Show child attributes
namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
Show child attributes
namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
itemsFolderContentItem[]
breadcrumbsFolderBreadcrumb[]
itemsFolderContentItem[]
Show child attributes
resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
breadcrumbsFolderBreadcrumb[]
Show child attributes
folder_uuidstringrequired
namestringrequired
itemsFolderContentItem[]
Show child attributes
resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
breadcrumbsFolderBreadcrumb[]
Show child attributes
folder_uuidstringrequired
namestringrequired
itemsFolderContentItem[]
Show child attributes
resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
breadcrumbsFolderBreadcrumb[]
Show child attributes
folder_uuidstringrequired
namestringrequired
Error responses
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "name": "Example name",
  "public": true,
  "description": "An example description",
  "thumbnail_image": "string",
  "color": "#0a0a0a",
  "id": 1,
  "org_id": 1,
  "folder_uuid": "string",
  "parent_folder_id": 1,
  "order": 0,
  "creation_date": "string",
  "update_date": "string",
  "total_items": 0,
  "subfolders": [],
  "items": [],
  "breadcrumbs": []
}

Add content to folder

POST/api/v1/folders/{folder_uuid}/content
API tokenfolders:createor user session

Place a resource (course/podcast/community/board/playground/media) into a folder.

Path parameters

folder_uuidstringrequired

Query parameters

resource_uuidstringrequired
positioninteger

Returns

FolderRead — Successful Response

namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
Show child attributes
namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
Show child attributes
namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
Show child attributes
namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
itemsFolderContentItem[]
breadcrumbsFolderBreadcrumb[]
itemsFolderContentItem[]
Show child attributes
resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
breadcrumbsFolderBreadcrumb[]
Show child attributes
folder_uuidstringrequired
namestringrequired
itemsFolderContentItem[]
Show child attributes
resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
breadcrumbsFolderBreadcrumb[]
Show child attributes
folder_uuidstringrequired
namestringrequired
itemsFolderContentItem[]
Show child attributes
resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
breadcrumbsFolderBreadcrumb[]
Show child attributes
folder_uuidstringrequired
namestringrequired
Error responses
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "name": "Example name",
  "public": true,
  "description": "An example description",
  "thumbnail_image": "string",
  "color": "#0a0a0a",
  "id": 1,
  "org_id": 1,
  "folder_uuid": "string",
  "parent_folder_id": 1,
  "order": 0,
  "creation_date": "string",
  "update_date": "string",
  "total_items": 0,
  "subfolders": [],
  "items": [],
  "breadcrumbs": []
}

Remove content from folder

DELETE/api/v1/folders/{folder_uuid}/content
API tokenfolders:deleteor user session

Remove a resource placement from a folder (the resource itself is not deleted).

Path parameters

folder_uuidstringrequired

Query parameters

resource_uuidstringrequired

Returns

FolderRead — Successful Response

namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
Show child attributes
namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
Show child attributes
namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
Show child attributes
namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
itemsFolderContentItem[]
breadcrumbsFolderBreadcrumb[]
itemsFolderContentItem[]
Show child attributes
resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
breadcrumbsFolderBreadcrumb[]
Show child attributes
folder_uuidstringrequired
namestringrequired
itemsFolderContentItem[]
Show child attributes
resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
breadcrumbsFolderBreadcrumb[]
Show child attributes
folder_uuidstringrequired
namestringrequired
itemsFolderContentItem[]
Show child attributes
resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
breadcrumbsFolderBreadcrumb[]
Show child attributes
folder_uuidstringrequired
namestringrequired
Error responses
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "name": "Example name",
  "public": true,
  "description": "An example description",
  "thumbnail_image": "string",
  "color": "#0a0a0a",
  "id": 1,
  "org_id": 1,
  "folder_uuid": "string",
  "parent_folder_id": 1,
  "order": 0,
  "creation_date": "string",
  "update_date": "string",
  "total_items": 0,
  "subfolders": [],
  "items": [],
  "breadcrumbs": []
}

Move content between folders

POST/api/v1/folders/{folder_uuid}/content/move
API tokenfolders:createor user session

Move a resource placement from this folder to a target folder.

Path parameters

folder_uuidstringrequired

Query parameters

target_folder_uuidstringrequired
resource_uuidstringrequired

Returns

FolderRead — Successful Response

namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
Show child attributes
namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
Show child attributes
namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
Show child attributes
namestringrequired
publicboolean
descriptionstring | null
thumbnail_imagestring | null
colorstring | null
idintegerrequired
org_idintegerrequired
folder_uuidstringrequired
parent_folder_idinteger | null
orderinteger
creation_datestringrequired
update_datestringrequired
total_itemsinteger
subfoldersFolderRead[]
itemsFolderContentItem[]
breadcrumbsFolderBreadcrumb[]
itemsFolderContentItem[]
Show child attributes
resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
breadcrumbsFolderBreadcrumb[]
Show child attributes
folder_uuidstringrequired
namestringrequired
itemsFolderContentItem[]
Show child attributes
resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
breadcrumbsFolderBreadcrumb[]
Show child attributes
folder_uuidstringrequired
namestringrequired
itemsFolderContentItem[]
Show child attributes
resource_uuidstringrequired
resource_typestringrequired
positioninteger
resourceResourcerequired
breadcrumbsFolderBreadcrumb[]
Show child attributes
folder_uuidstringrequired
namestringrequired
Error responses
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "name": "Example name",
  "public": true,
  "description": "An example description",
  "thumbnail_image": "string",
  "color": "#0a0a0a",
  "id": 1,
  "org_id": 1,
  "folder_uuid": "string",
  "parent_folder_id": 1,
  "order": 0,
  "creation_date": "string",
  "update_date": "string",
  "total_items": 0,
  "subfolders": [],
  "items": [],
  "breadcrumbs": []
}