Global Search | OCT-103 Gumlet outreach

8 parameters

search_querystringrequired

Search query term

workspace_idstringoptional

Gumlet video workspace ID. Preferred. Provide workspace_id, or deprecated collection_id / source_id (same ID).

collection_idstringoptional

Deprecated. Use workspace_id instead. Still accepted for backwards compatibility.

sizeintegeroptional

Number of results to return

Default:20

assets_offsetintegeroptional

Offset for assets

Default:0

folders_offsetintegeroptional

Offset for folders

Default:0

playlists_offsetintegeroptional

Offset for playlists

Default:0

channels_offsetintegeroptional

Offset for channels

Default:0

4 status codes

200Successful response

all_assetsarray<object>required

Result array of all assets

all_channelsarray<object>required

Result array of all channels

all_foldersarray<object>required

Result array of all folders

all_playlistsarray<object>required

Result array of all playlists

400Bad Request

One documented failure

parameter_missing
One or more required values are missing.

errorobjectrequired

401Unauthorized — missing or invalid API key / bearer token

One documented failure

invalid_api_key
API key supplied with request is invalid

errorobjectrequired

403Forbidden — unpaid account or insufficient role permissions

One documented failure

unauthorized
You don't have access to this feature. Please contact your organization owner.

errorobjectrequired

Error handling

A 400 is returned: Bad Request. A 401 is returned: Unauthorized — missing or invalid API key / bearer token. A 403 is returned: Forbidden — unpaid account or insufficient role permissions.

import { Gumlet } from "oct-103-gumlet-outreach-sdk";

const client = new Gumlet({
  baseUrl: "https://api.gumlet.com/v1",
  auth: { apiKey: process.env.GUMLET_API_KEY! },
});

const result = await client.globalSearch.globalSearch({ searchQuery: "keyword" });

{
  "all_assets": [
    {
      "created_at": 1,
      "highlight": [
        {
          "path": "example_value",
          "score": 1,
          "texts": [
            {
              "type": null,
              "value": null
            }
          ]
        }
      ],
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "tags": [
        "example_value"
      ],
      "title": "Example Title",
      "updated_at": "2026-01-15T09:00:00Z",
      "workspace_id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "all_channels": [
    {
      "created_at": 1,
      "description": "Example description",
      "highlight": [
        {
          "path": "example_value",
          "score": 1,
          "texts": [
            {
              "type": null,
              "value": null
            }
          ]
        }
      ],
      "title": "Example Title",
      "updated_at": "2026-01-15T09:00:00Z",
      "workspace_id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "all_folders": [
    {
      "created_at": 1,
      "highlight": [
        {
          "path": "example_value",
          "score": 1,
          "texts": [
            {
              "type": null,
              "value": null
            }
          ]
        }
      ],
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "updated_at": "2026-01-15T09:00:00Z",
      "workspace_id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "all_playlists": [
    {
      "created_at": 1,
      "description": "Example description",
      "highlight": [
        {
          "path": "example_value",
          "score": 1,
          "texts": [
            {
              "type": null,
              "value": null
            }
          ]
        }
      ],
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "title": "Example Title",
      "updated_at": "2026-01-15T09:00:00Z",
      "workspace_id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}

Request

Response

Errors