Graph API Version

Album Photos

Represents a collection Photos and Videos on an Album.

Reading

Get a list of Photos on an Album.

New Page Experience

This endpoint is supported for New Page Experience.

Example

GET /v21.0/{album-id}/photos 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}/photos',
    '{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}/photos",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{album-id}/photos",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();

/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{album-id}/photos"
                                      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

Reading from this edge will return a JSON formatted result:

{
    "data": [],
    "paging": {}
}

`data`

A list of Photo nodes.

`paging`

For more details about pagination, see the Graph API guide.

Error Codes

Error	Description
190	Invalid OAuth 2.0 Access Token
104	Incorrect signature
200	Permissions error
100	Invalid parameter
80001	There 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.

Creating

Animated photos are not supported, and a photo must be less than 10MB in size.

You can make a POST request to photos edge from the following paths:

/{album_id}/photos

When posting to this edge, a Photo will be created.

Parameters

Parameter	Description
`aid` string	Legacy album ID. Deprecated
`allow_spherical_photo` boolean	Default value: `false` Indicates that we should allow this photo to be treated as a spherical photo. This will not change the behavior unless the server is able to interpret the photo as spherical, such as via Photosphere XMP metadata. Regular non-spherical photos will still be treated as regular photos even if this parameter is true.
`alt_text_custom` string	Accessible alternative description for an image
`android_key_hash` string	Android key hash
`application_id` non-empty string	iTunes App ID. This is used by the native Share dialog that's part of iOS
`attempt` int64	Default value: `0` Number of attempts that have been made to upload this photo
`audience_exp` boolean	Default value: `false` Audience exp
`backdated_time` datetime/timestamp	A user-specified creation time for this photo
`backdated_time_granularity` enum{year, month, day, hour, min, none}	Default value: `none` Use only the part of the `backdated_time` parameter to the specified granularity
`caption` string	The description of the photo
`composer_session_id` string	Composer session ID
`direct_share_status` int64	The status to allow sponsor directly boost the post.
`feed_targeting` feed target	Object that controls News Feed targeting for this post. Anyone in these groups will be more likely to see this post. People not in these groups will be less likely to see this post, but may still see it anyway. Any of the targeting fields shown here can be used, but none are required. `feed_targeting` applies to Pages only.
`geo_locations` Object
`countries` list<string>
`regions` list<Object>
`key` int64
`cities` list<Object>
`key` int64
`zips` list<Object>
`key` string
`locales` list<string>	Values for targeted locales. Use `type` of `adlocale` to find Targeting Options and use the returned key to specify.
`age_min` int64	Must be `13` or higher. Default is 0.
`age_max` int64	Maximum age.
`genders` list<int64>	Target specific genders. `1` targets all male viewers and `2` females. Default is to target both.
`college_years` list<int64>	Array of integers. Represent graduation years from college.
`education_statuses` list<int64>	Array of integers which represent current educational status. Use `1` for high school, `2` for undergraduate, and `3` for alum (or localized equivalents).
`interested_in` list<int64>	Deprecated. Please see the Graph API Changelog for more information. Deprecated
`relationship_statuses` list<int64>	Array of integers for targeting based on relationship status. Use `1` for single, `2` for 'in a relationship', `3` for married, and `4` for engaged. Default is all types.
`interests` list<int64>	One or more IDs of pages to target fans of pages.Use `type` of `page` to get possible IDs as find Targeting Options and use the returned id to specify.
`filter_type` int64	Default value: `-1` Unused?
`full_res_is_coming_later` boolean	Default value: `false` Full res is coming later
`initial_view_heading_override_degrees` int64	Manually specify the initial view heading in degrees from 0 to 360. This overrides any value present in the photo embedded metadata or provided in the spherical_metadata parameter
`initial_view_pitch_override_degrees` int64	Manually specify the initial view pitch in degrees from -90 to 90. This overrides any value present in the photo embedded metadata or provided in the spherical_metadata parameter
`initial_view_vertical_fov_override_degrees` int64	Manually specify the initial view vertical FOV in degrees from 60 to 120. This overrides any value present in the photo embedded metadata or provided in the spherical_metadata parameter
`ios_bundle_id` string	iOS Bundle ID
`is_explicit_location` boolean	Is this an explicit location?
`is_explicit_place` boolean	If set to `true`, the tag is a place, not a person
`manual_privacy` boolean	Default value: `false` Manual privacy
`message` string	Deprecated. Please use the caption param instead.
`name` string	Deprecated. Please use the caption param instead.
`no_story` boolean	If set to `true`, this will suppress the News Feed story that is automatically generated on a profile when people upload a photo using your app. Useful for adding old photos where you may not want to generate a story
`offline_id` int64	Default value: `0` Offline ID
`og_action_type_id` numeric string	The Open Graph action type
`og_icon_id` numeric string	The Open Graph icon
`og_object_id` OG object ID or URL string	The Open Graph object ID
`og_phrase` string	The Open Graph phrase
`og_set_profile_badge` boolean	Default value: `false` Flag to set if the post should create a profile badge
`og_suggestion_mechanism` string	The Open Graph suggestion
`place` place tag	Page ID of a place associated with the photo
`privacy` Privacy Parameter	Determines the privacy settings of the photo. If not supplied, this defaults to the privacy level granted to the app in the Login dialog. This field cannot be used to set a more open privacy setting than the one granted
`profile_id` int	Deprecated. Use `target_id` instead Deprecated
`proxied_app_id` numeric string or integer	Proxied app ID
`published` boolean	Default value: `true` Set to `false` if you don't want the photo to be published immediately
`qn` string	Photos waterfall ID
`spherical_metadata` JSON object	A set of params describing an uploaded spherical photo. This field is not required; if it is not present we will try to generate spherical metadata from the metadata embedded in the image. If it is present, it takes precedence over any embedded metadata. Please click to the left to expand this list and see more information on each parameter. See also the Google Photo Sphere spec for more info on the meaning of the params: https://developers.google.com/streetview/spherical-metadata
`ProjectionType` string	Accepted values include equirectangular (full spherical photo), cylindrical (panorama), and cubestrip (also known as cubemap, e.g. for synthetic or rendered content; stacked vertically with 6 faces). Required
`CroppedAreaImageWidthPixels` int64	--- In equirectangular projection: As described in Google Photo Sphere XMP Metadata spec. --- In cylindrical projection: Very similar to equirectangular. This value should be equal to the actual width of the image, and together with FullPanoWidthPixels, it describes the horizontal FOV of content of the image: HorizontalFOV = 360 * CroppedAreaImageWidthPixels / FullPanoWidthPixels. --- In cubestrip projection: This has no relationship to the pixel dimensions of the image. It is simply a representation of the horizontal FOV of the content of the image. HorizontalFOV = CroppedAreaImageWidthPixels / PixelsPerDegree, where PixelsPerDegree is defined by FullPanoWidthPixels. Required
`CroppedAreaImageHeightPixels` int64	--- In equirectangular projection: As described in Google Photo Sphere XMP Metadata spec. --- In cylindrical projection: This value will NOT be equal to the actual height of the image. Instead, together with FullPanoHeightPixels, it describes the vertical FOV of the image: VerticalFOV = 180 * CroppedAreaImageHeightPixels / FullPanoHeightPixels. In other words, this value is equal to the CroppedAreaImageHeightPixels value that this image would have, if it were projected into equirectangular format while maintaining the same FullPanoWidthPixels. --- In cubestrip projection: This has no relationship to the pixel dimensions of the image. It is simply a representation of the vertical FOV of the content of the image. VerticalFOV = CroppedAreaImageHeightPixels / PixelsPerDegree, where PixelsPerDegree is defined by FullPanoWidthPixels. Required
`FullPanoWidthPixels` int64	--- In equirectangular projection: As described in Google Photo Sphere XMP Metadata spec. --- In cylindrical projection: Very similar to equirectangular. This value defines a ratio of horizontal pixels to degrees in the space of the image, and in general the pixel to degree ratio in the scope of the metadata object. Concretely, PixelsPerDegree = FullPanoWidthPixels / 360. This is also equivalent to the circumference of the cylinder used to model this projection. --- In cubestrip projection: This value has no relationship to the pixel dimensions of the image. It only defines the pixel to degree ratio in the scope of the metadata object. It represents the number of pixels in 360 degrees, so pixels per degree is then given by: PixelsPerDegree = FullPanoWidthPixels / 360. As an example, if FullPanoWidthPixels were chosen to be 3600, we would have PixelsPerDegree = 3600 / 360 = 10. An image with a vertical field of view of 65 degrees would then have a CroppedAreaImageHeightPixels value of 65 * 10 = 650. Required
`FullPanoHeightPixels` int64	--- In equirectangular projection: As described in Google Photo Sphere XMP Metadata spec. --- In cylindrical projection: This value is equal to the FullPanoHeightPixels value that this image would have, if it were projected into equirectangular format while maintaining the same FullPanoWidthPixels. It is always equal to FullPanoWidthPixels / 2. --- In cubestrip projection: This value has no relationship to the pixel dimensions of the image. It is a second, redundant representation of PixelsPerDegree. FullPanoHeightPixels = 180 * PixelsPerDegree. It must be consistent with FullPanoWidthPixels: FullPanoHeightPixels = FullPanoWidthPixels / 2. Required
`CroppedAreaLeftPixels` int64	Default value: `0` --- In equirectangular projection: As described in Google Photo Sphere XMP Metadata spec. --- In cylindrical projection: This value is equal to the CroppedAreaLeftPixels value that this image would have, if it were projected into equirectangular format while maintaining the same FullPanoWidthPixels. It is just a representation of the same angular offset that it represents in equirectangular projection in the Google Photo Sphere spec. Concretely, AngularOffsetFromLeftDegrees = CroppedAreaLeftPixels / PixelsPerDegree, where PixelsPerDegree is defined by FullPanoWidthPixels. --- In cubestrip projection: This value has no relationship to the pixel dimensions of the image. It is just a representation of the same angular offset that it represents in equirectangular projection in the Google Photo Sphere spec. AngularOffsetFromLeftDegrees = CroppedAreaLeftPixels / PixelsPerDegree, where PixelsPerDegree is defined by FullPanoWidthPixels.
`CroppedAreaTopPixels` int64	Default value: `0` --- In equirectangular projection: As described in Google Photo Sphere XMP Metadata spec. --- In cylindrical projection: This value is equal to the CroppedAreaTopPixels value that this image would have, if it were projected into equirectangular format while maintaining the same FullPanoWidthPixels. It is just a representation of the same angular offset that it represents in equirectangular projection in the Google Photo Sphere spec. Concretely, AngularOffsetFromTopDegrees = CroppedAreaTopPixels / PixelsPerDegree, where PixelsPerDegree is defined by FullPanoWidthPixels. --- In cubestrip projection: This value has no relationship to the pixel dimensions of the image. It is just a representation of the same angular offset that it represents in equirectangular projection in the Google Photo Sphere spec. AngularOffsetFromTopDegrees = CroppedAreaTopPixels / PixelsPerDegree, where PixelsPerDegree is defined by FullPanoWidthPixels.
`PoseHeadingDegrees` float
`PosePitchDegrees` float
`PoseRollDegrees` float
`InitialViewHeadingDegrees` float
`InitialViewPitchDegrees` float
`InitialViewRollDegrees` float	This is not currently supported
`InitialViewVerticalFOVDegrees` float	This is deprecated. Please use InitialVerticalFOVDegrees.
`InitialVerticalFOVDegrees` float	You can set the intial vertical FOV of the image. You can set either this field or InitialHorizontalFOVDegrees.
`InitialHorizontalFOVDegrees` float	You can set the intial horizontal FOV of the image. You can set either this field or InitialVerticalFOVDegrees.
`PreProcessCropLeftPixels` int64
`PreProcessCropRightPixels` int64
`sponsor_id` numeric string or integer	Facebook Page id that is tagged as sponsor in the photo post
`sponsor_relationship` int64	Sponsor Relationship, such as Presented By or Paid PartnershipWith
`tags` list<Object>	Tags on this photo
`x` float	The x-axis offset for the tag
`y` float	The y-axis offset for the tag
`tag_uid` int	The user_id of the tagged person
`tag_text` string	Text associated with the tag
`target_id` int	Don't use this. Specifying a `target_id` allows you to post the photo to an object that's not the user in the access token. It only works when posting directly to the `/photos` endpoint. Instead of using this parameter you should be using the edge on an object directly, like `/page/photos`.
`targeting` target	Allows you to target posts to specific audiences. Applies to Pages only
`geo_locations` Object
`countries` list<string>
`regions` list<Object>
`key` int64
`cities` list<Object>
`key` int64
`zips` list<Object>
`key` string
`locales` list<string>
`excluded_countries` list<string>
`excluded_regions` list<int64>
`excluded_cities` list<int64>
`excluded_zipcodes` list<string>
`timezones` list<int64>
`age_min` enum {13, 15, 18, 21, 25}
`time_since_original_post` int64	Same as `backdated_time` but with a time delta instead of absolute time
`uid` int	Deprecated
`unpublished_content_type` enum {SCHEDULED, SCHEDULED_RECURRING, DRAFT, ADS_POST, INLINE_CREATED, PUBLISHED, REVIEWABLE_BRANDED_CONTENT}	Content type of the unpublished content type
`url` string	The URL of a photo that is already uploaded to the Internet. You must specify this or a file attachment
`user_selected_tags` boolean	Default value: `false` User selected tags
`vault_image_id` numeric string or integer	A vault image ID to use for a photo. You can use only one of `url`, a file attachment, `vault_image_id`, or `sync_object_uuid`

Return Type

This endpoint supports read-after-write and will read the node represented by id in the return type.

Struct {

id: numeric string,

post_id: token with structure: Post ID,

}

Error Codes

Error	Description
190	Invalid OAuth 2.0 Access Token
368	The action attempted has been deemed abusive or is otherwise disallowed
321	Album is full
200	Permissions error
100	Invalid parameter
324	Missing or invalid image file
220	Album or albums not visible
120	Invalid album id

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.