OCT-103 Gumlet outreach
GET/channel/{workspace_id}/viewers

List video channel subscribers

Lists subscribers for a video channel in a workspace. Use page_number and page_size to paginate the results. The response includes subscriber details and the total subscriber count.

3 parameters
workspace_idstringrequired

Gumlet workspace ID for the channel; retrieve it from the dashboard or the workspace listing API.

page_numberintegeroptional

Page number to retrieve. Defaults to 1 when omitted and must be an integer of at least 1.

Default:1
page_sizeintegeroptional

Number of subscribers to return per page. Defaults to 10 when omitted and must be an integer of at least 1.

Default:10

4 status codes
200Returns a subscriptions array containing subscriber details and a total_count of subscribers.
subscriptionsarray<object>required

Details about subscribers

total_countintegerrequired

Number of total subscribers

400Returned when the request is invalid.

One documented failure

  • channel_not_found

    Could not find any channel with specified 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 has unpaid dues or the authenticated user lacks the required 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 when the request is invalid; page_number and page_size must be integers of at least 1. A 401 is returned when the API key or bearer token is missing or invalid. A 403 is returned when the account has unpaid dues or the authenticated user lacks the required role permissions. The workspace_id path parameter identifies the workspace whose subscribers you are listing.