Skip to main content
POST
List YouTube Videos

Authorizations

x-api-key
string
header
required

API key for authentication. You can create one here.

Body

application/json
website_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
filters
object
required
page_num
integer
default:0

Zero-based page number.

Required range: 0 <= x <= 1000000
page_size
integer
default:30
Required range: 1 <= x <= 100
channel_key
string

Channel group key from get_youtube_creators; omit for all creators.

Required string length: 1 - 500
video_id
string

YouTube video ID; omit for all videos.

Pattern: ^[A-Za-z0-9_-]{11}$

Response

Success

videos
object[]
required
pagination
object
required
notice
string