GET Videos API
Many times you need to retrieve the content keys, titles, descriptions, etc for videos. This API call will retrieve the videos associated with an organization and all of the metadata about those videos.
Retrieve videos for your organization
This GET request retrieves the videos associated with your organization. Your organization key will be provided by ParOne.
GET
https://videos-prod.parone.app/get_videos?organization_key=YOUR_ORGANIZATION_KEY&start=0&limit=100
GET
https://videos-prod.parone.app/get_videos?organization_key=YOUR_ORGANIZATION_KEY&&content_key=abcde
Call Parameters
Field | Value | Notes |
---|---|---|
organization_key | the organization key provided by ParOne | |
start | the start of the results. 0 indexed | defaults to 0 |
limit | the maximum number of results to return | defaults to 100 |
content_key | the content key for the video you want to retrieve information for | Gets the video info for one video. If you have this start/limit are ignored. |
ownVideos | 1 or 0 | 1 if you want to restrict the videos to your own videos. Omit or 0 if you want all the videos available to your organization. |
privateCategories | 1 or 0 | 1 if you want to include the video’s private categories. Omit or 0 to not return private categories |
privateTags | 1 or 0 | 1 if you want to include the video’s private tags. Omit or 0 to not return private tags. |
Return Value
This call will return a JSON object that has a list of videos for your organization.
Structure of the Returned Results
The content_key and feed_code are used to parameterize the <parone-video-block>
.
Field | Value | Comments |
---|---|---|
count | The total number of videos matching the query. Note that if no limit is specified this call will return 100 videos. | |
content_key | The content key for this video | Used across the ParOne API to identify a piece of content. |
created_date | The date the video was created | in UTC |
description | The video description | |
privateCategories | The private (organization-specific) categories associated with this video | |
privateTags | The private (organization-specific) tags associated with this video | |
thumbnail | The video’s thumbnail | |
title | The video’s title |