Graph API Version

Video List

A list of videos in the Graph API. Used from other nodes like Pages that might have a list of videos

Reading

A playlist for videos

Permissions

Developers usually request these permissions for this endpoint:

Marketing Apps
  • ads_management
  • manage_pages
  • pages_show_list
  • business_management
Page management Apps
No data
Other Apps
Permissions are not usually requested.

Example

Graph API Explorer
GET /v2.12/{video-list-id} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{video-list-id}',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "/{video-list-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{video-list-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{video-list-id}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription
id
numeric string

Video playlist ID

creation_time
datetime

The time when the playlist was created

description
string

Description of the playlist

last_modified
datetime

The time when the contents of the playlist was last changed

owner
User|Page

Owner of the playlist

season_number
int32

Number of Season which this episode belongs to

thumbnail
string

Thumbnail of the playlist

title
string

Title of the playlist

videos_count
int32

Number of Videos in the playlist

Edges

EdgeDescription

videos

Videos in the playlist

Validation Rules

ErrorDescription
100Invalid parameter

Creating

You can make a POST request to video_lists edge from the following paths:
When posting to this edge, a VideoList will be created.

Parameters

NameDescription
description
UTF-8 string

Description of the playlist

Supports Emoji
title
UTF-8 string

Title of the playlist

RequiredSupports Emoji

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
}

Validation Rules

ErrorDescription
100Invalid parameter

Updating

You can update a VideoList by making a POST request to /{video_list_id}/videos.

Parameters

NameDescription
video_ids
list<numeric string or integer>

IDs of videos to be added into the video list

Required

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
}

Validation Rules

ErrorDescription
100Invalid parameter

Deleting

You can dissociate a VideoList from a VideoList by making a DELETE request to /{video_list_id}/videos.

Parameters

NameDescription
video_ids
list<numeric string or integer>

IDs of videos to be removed from the video list

Required

Return Type

Struct {
success: bool,
}
You can dissociate a VideoList from a Page by making a DELETE request to /{page_id}/video_lists.

Parameters

NameDescription
video_list_id
numeric string or integer

ID of the video list to be deleted

Required

Return Type

Struct {
success: bool,
}

Validation Rules

ErrorDescription
100Invalid parameter