How to generate a list of subscribers to a channel using Kaltura API

You can use Kaltura’s API tools to list all users subscribed to a specific channel (category). Here's how:

1. Open the API console

Use one of the following:

• Kaltura API Console (Sign In)
• TestMe Console

2. Paste your session key

In the field labeled “Kaltura API session (string)”, paste your generated session key.

3. Set up the API call

• Service: categoryUser
• Action: list

Under filter (KalturaCategoryUserFilter):

• Set categoryIdEqual to the ID of your channel (Category ID).
• Set permissionNamesMatchAnd to: CATEGORY_SUBSCRIBE

4. (Optional) Handle large result sets

If your channel has more than 500 subscribers:

1. Under pager (KalturaFilterPager), click Edit.
2. Set:
   • pageSize: 500
   • pageIndex: 1
3. Click Send to get the first batch.
4. If the total count is higher than 500, increment pageIndex to fetch the next batch (e.g., 2, 3, etc.).

Repeat as needed.

5. Export the results to excel

1. Copy the XML output from the results area into a text editor (e.g., Notepad++).
2. Save the file with an .xml extension.
3. Open the file in Microsoft Excel.
4. (Optional) You can convert it to a CSV file if preferred. See How to convert an XML file to a CSV or Excel spreadsheet.

Was this article helpful?

Thank you for your feedback!

Name

Email

Submit your feedback

Thank you! Your comment has been submitted.