Skip to main content
GET
/
api
/
public
/
v1
/
folder
/
list
curl -X GET "https://app.hoox.video/api/public/v1/folder/list" \
  -H "Authorization: Bearer your_api_key"
{
  "folders": [
    {
      "id": "662f8c1d3a4b5e6f70123456",
      "name": "Summer Campaign",
      "type": "assets",
      "parent_folder_id": null,
      "created_at": "2026-06-19T10:00:00.000Z"
    },
    {
      "id": "662f8c1d3a4b5e6f70987654",
      "name": "Hero shots",
      "type": "assets",
      "parent_folder_id": "662f8c1d3a4b5e6f70123456",
      "created_at": "2026-06-19T10:05:00.000Z"
    }
  ]
}

Overview

Returns the folders in your space. By default it returns every folder; pass type to return only asset folders or only video folders. Use a folder’s id as folder_id when calling Submit Asset Generation, or check this list before creating a new folder to avoid duplicates.

Authentication

This endpoint requires API key authentication. Include your API key in the Authorization header.

Query Parameters

type
string
Filter by folder type: assets or videos. Omit to return folders of all types.

Response

folders
array
Array of folder objects.

Examples

curl -X GET "https://app.hoox.video/api/public/v1/folder/list" \
  -H "Authorization: Bearer your_api_key"
{
  "folders": [
    {
      "id": "662f8c1d3a4b5e6f70123456",
      "name": "Summer Campaign",
      "type": "assets",
      "parent_folder_id": null,
      "created_at": "2026-06-19T10:00:00.000Z"
    },
    {
      "id": "662f8c1d3a4b5e6f70987654",
      "name": "Hero shots",
      "type": "assets",
      "parent_folder_id": "662f8c1d3a4b5e6f70123456",
      "created_at": "2026-06-19T10:05:00.000Z"
    }
  ]
}

Notes

  • Omitting type returns folders of every type; subfolders are identified by a non-null parent_folder_id.