Graph API Version

Album

Represents an Album.

Reading

Get Fields and Edges on an Album.

Requirements

Requirements depend on the type of node that the Album is on.

RequirementUser nodesPage nodesGroup nodes

Access Tokens

Any

Any

User

Features

None

To get public Page content of Pages you can not perform a task on, you will need Page Public Content Access

None

Permissions

user_photos

Unpublished Pages:

Published Pages:

None

Group Roles

Not applicable

Not applicable

Admin

Example

Graph API Explorer
GET /v8.0/{album-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(
    '/{album-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(
    "/{album-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{album-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:@"/{album-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

The Album ID.

backdated_time
datetime

A user-specified time for when this object was created

backdated_time_granularity
enum

How accurate the backdated time is

can_upload
bool

Whether the app user can upload photos to this Album

count
unsigned int32

The approximate number of Photos and Videos in the Album.

cover_photo

Album cover photo id

created_time
datetime

The Album creation date and time.

description
string

The Album description.

event

If this object has a place, the event associated with the place

from
User|Page

The User who created the Album.

link
token with structure: URL

A link to this Album on Facebook.

location
string

The Album textual location.

name
string

The Album title.

place

Place info

privacy
string

The Album privacy settings.

type
string

The Album type: album, app, cover, profile, mobile, normal, or wall

updated_time
datetime

The date and time the Album was last updated.

Edges

EdgeDescription

Represents a collection of Comments on the Album.

A collection of Profiles who like the Album.

A collection of Photos in the Album

A link to the Album cover photo.

A collection of Profiles who reacted on the Album

Shared posts

Validation Rules

ErrorDescription
200Permissions error
100Invalid parameter
80001There have been too many calls to this Page account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.
190Invalid OAuth 2.0 Access Token

Creating

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

Parameters

ParameterDescription
contributors
list<int>

Contributors to turn this into a shared album

description
UTF-8 string

Deprecated. Use the message param

DeprecatedSupports Emoji
is_default
boolean
Default value: false

true indicates that the request will create the application specific album

location
string

A text location of the Album for non-page locations

make_shared_album
boolean
Default value: false

Ensures the created Album is a shared Album

message
string

The Album's caption. This appears below the title of the album in the Album view

name
UTF-8 string

The title of the Album

Supports Emoji
place
place tag

The ID of a location page to tag the Album with

privacy
Privacy Parameter

The privacy of the Album

tags
list<int>

Deprecated

Deprecated
visible
string

Deprecated. Use privacy

Deprecated

Return Type

This endpoint supports read-after-write and will read the node represented by id in the return type.
Struct {
id: numeric string,
}

Validation Rules

ErrorDescription
200Permissions error
100Invalid parameter

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.