Logo
Zoom Public API Documentation

Get a user's playlist

GET {{baseUrl}}/iq/users/:userId/conversations/playlists?page_size=30&next_page_token=<string>&type=All&following=false&create_by_self=false

Get all playlists for a user.

Scopes: iq_playlist:read:admin,iq_playlist:read

Rate Limit Label: MEDIUM

 

Body PARAM

Key Datatype Required Description 
page_size
number The number of records returned within a single API call.
next_page_token
string The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
type
string The type of the playlist to query: * `All` - All playlists. * `Normal` - Normal playlist. * `Smart` - Smart playlist. * `Favorite` - Favorite playlist.
following
boolean Whether to see Following only.
create_by_self
boolean Whether to see playlist created by self.



HEADERS

Key Datatype Required Description 
Accept
string




RESPONSES

status OK

{ "next_page_token": "<string>", "page_size": 30, "playlists": [ { "playlist_id": "<string>", "type": "<string>", "modified_time": "<dateTime>", "playlist_name": "<string>", "number_of_conversations": "<integer>", "following": "<boolean>", "created_by": "<string>" }, { "playlist_id": "<string>", "type": "<string>", "modified_time": "<dateTime>", "playlist_name": "<string>", "number_of_conversations": "<integer>", "following": "<boolean>", "created_by": "<string>" } ] }



Curl
curl -X GET 'https://api.zoom.us/v2/iq/users/:userId/conversations/playlists?page_size=30&next_page_token=<string>&type=All&following=false&create_by_self=false?page_size=30&next_page_token=<string>&type=All&following=false&create_by_self=false' -H 'Accept: application/json'

ENDPOINTS