Sign in
videos

Get video by ID

Get a single video by its ID (requires authentication)

get/api/videos/{video_id}

Path parameters

video_idinteger required

Response

Successful Response

idinteger required

Video ID

created_atstring required

Creation timestamp

youtube_urlstring nullable

YouTube URL

titlestring required

Video title

descriptionstring required

Video description

typestring nullable

Video type/category

video_idstring nullable

Video identifier

thumbnailstring nullable

Base64 encoded video thumbnail

badge_namestring nullable

Badge name to display for this video in app/website

is_lockedboolean

Whether the video is visible but not playable

locked_messagestring nullable

Reason shown when the video is locked

cta_urlstring nullable

CTA URL/path shown when the video is locked

cta_labelstring nullable

CTA label shown when the video is locked

Example response

{
  "badge_name": "Consigliato",
  "created_at": "2024-01-01T00:00:00Z",
  "description": "This is an example video description",
  "id": 1,
  "title": "Video Example",
  "type": "educational",
  "video_id": "example123",
  "youtube_url": "https://www.youtube.com/watch?v=example"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.