OCT-103 Gumlet outreach
GET/video/workspaces/{workspace_id}

Get video workspace details

Retrieves the details of an existing video workspace. Use the workspace_id to fetch its settings, folders, player configuration, and other workspace data.

1 parameter
workspace_idstringrequired

The Gumlet workspace ID, available in the dashboard or from the workspace list.

5 status codes
200Returns the workspace object, including its ID, name, type, timestamps, folders, channel settings, and player configuration.
channel_settingsobjectrequired
created_atstringrequired

ISO 8601 formatted creation timestamp of this workspace.

data_localizationstringoptional

Data storage region

Allowed:usineuDefault:us
default_profile_idstringoptional

Profile ID for the default profile of this workspace

default_profile_updated_atstringoptional

ISO 8601 formatted profile update timestamp

distinct_tagsarray<string>optional

List of distinct tags in entire workspace.

foldersarray<string>required

List of folder names in this workspace.

idstringrequired

Workspace ID

insights_enabledbooleanrequired

Whether Gumlet video analytics is enabled for video embeds in this workspace.

namestringrequired

Workspace Name

on_streaming_haltbooleanoptional

true means the workspace is disabled for streaming. No videos will stream from this workspace.

player_configobjectrequired

Video player configuration

storage_event_listenerarray<object>optional
typestringrequired

Workspace Type

updated_atstringrequired

ISO 8601 formatted update timestamp of this workspace.

video_protectionobjectoptional
400Returned when the request is invalid.

One documented failure

  • collection_not_found

    Could not find any video workspace with specified workspace_id.

errorobjectrequired
401Returned when the API key or bearer token is missing or invalid.

One documented failure

  • invalid_api_key

    API key supplied with request is invalid

errorobjectrequired
403Returned when the account is unpaid or the authenticated user lacks sufficient role permissions.

One documented failure

  • unauthorized

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

errorobjectrequired
404Returned when the workspace is not found.

One documented failure

  • collection_not_found

    Could not find any video workspace with specified workspace_id.

errorobjectrequired

Error handling

The workspace_id path parameter must identify an existing workspace. A 400 indicates a bad request, a 401 indicates missing or invalid authentication, a 403 indicates an unpaid account or insufficient role permissions, and a 404 indicates the workspace was not found.