List Assets

​

List folders and assets for a workspace in a single response. Use parent_id to browse a specific folder, or filters like title, status, and playlist_id to search assets.

Path Parameters
  • workspace_id
    Type: string
    required

    Video workspace id.

Query Parameters
  • type
    Type: string enum

    Return folders, videos, or all. Default is all.

    values
    • folders
    • videos
    • all
  • parent_id
    Type: string

    Parent folder id. Send null to browse the root level.

  • title
    Type: string

    Search folders or assets by title or description.

  • status
    Type: string

    Comma-separated asset status values.

  • tag
    Type: string

    Comma-separated asset tags.

  • playlist_id
    Type: string

    Filter assets to a playlist.

  • start_date
    Type: string

    Asset created_at lower bound.

  • end_date
    Type: string

    Asset created_at upper bound.

  • min_duration
    Type: number

    Minimum asset duration in seconds.

  • max_duration
    Type: number

    Maximum asset duration in seconds.

  • sortBy
    Type: string enum

    Sort assets by a supported field.

    values
    • title
    • duration
    • uploaded_at
    • created_at
  • orderBy
    Type: string enum

    Asset sort order.

    values
    • asc
    • desc
  • searchIndex
    Type: string enum

    Search index used for asset title search.

    values
    • search_index_for_asset_list
    • cms-search
    • cms-search-v2
  • offset
    Type: integer

    Offset for paginated results.

  • size
    Type: integer
    max:  
    100

    Page size. Maximum 100.

  • signed_token
    Type: string enum

    Whether URLs should be pre-signed in the API response. Possible values: true and false. Default is false.

    values
    • true
    • false
Responses
  • application/json
  • application/json
Request Example for get/video/workspaces/{workspace_id}/list
import Gumlet from '@gumlet/nodejs-sdk';

const client = new Gumlet({
  apiKey: process.env['API_KEY'], // defaults to the API_KEY env var
});

const videoAsset = await client.videoAssets.list('workspaceId', {
  type: 'all',
  offset: 0,
  size: 20,
  signed_token: 'false',
});

console.log(videoAsset);

{
  "folders": [
    {
      "id": "67e4f01d403562dbea6542d4",
      "name": "Course Assets",
      "video_source_id": "67e4ece9403562dbea65425f",
      "parent_id": null,
      "path": [],
      "path_names": [],
      "depth": 0,
      "subdirectory_count": 2,
      "asset_count": 12,
      "created_at": "2026-03-18T10:00:00.000Z",
      "updated_at": "2026-03-18T10:15:00.000Z"
    }
  ],
  "all_assets": [
    {
      "asset_id": "67e4f2b4403562dbea654301",
      "status": "ready",
      "title": "Lesson 1",
      "folder": "Course Assets"
    }
  ],
  "folder_count": 1,
  "asset_count": 1,
  "total_count": 2,
  "current_offset": 2
}

200