Graph API Version

Page Picture

Picture belonging to a Facebook Page.

A Page Access Token is required for all methods.

Reading

This Page's profile picture

Example

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

NameDescription
height
integer

The height of this picture in pixels.

redirect
boolean
Default value: true

By default the picture edge will return a picture instead of a JSON response. If you want the picture edge to return JSON that describes the image set redirect=0 when you make the request.

type
enum{small, normal, album, large, square}

The size of this picture. It can be one of the following values: small, normal, large, square.

width
integer

The width of this picture in pixels.

Fields

Reading from this edge will return a JSON formatted result:

{ "data": "ProfilePictureSource", "paging": {} }

data

A single ProfilePictureSource node.

paging

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

Validation Rules

ErrorDescription
100Invalid parameter
159Invalid protocol, must be https
200Permissions error

Creating

Permissions

  • A Page access token with publish_pages permission is required.
You can make a POST request to picture edge from the following paths:
When posting to this edge, a ProfilePictureSource will be created.

Parameters

NameDescription
android_key_hash
string

Android key hash for the proxied app ID.

caption
UTF-8 string

The caption for a profile pic

Supports Emoji
composer_session_id
string

Composer session ID

has_umg
boolean

Whether or not the picture uploaded has edits made in the unified media gallery

height
int64

Height for crop

ios_bundle_id
string

iOS bundle ID for the proxied app ID.

media_effect_ids
list<int>

Set of Media Effect IDs that were used on this pic

media_effect_source_object_id
int

The FBID of the media from which the effects were sourced.

msqrd_mask_id
string

MSQRD mask ID that was used to create this pic

photo
numeric string

ID of the photo to use as the profile pic

picture
URL

URL of the picture to upload

profile_pic_method
string

Method of the profile pic change for logging

profile_pic_source
string

Source of the profile pic change for logging

proxied_app_id
int

ID of the proxied app that performed this action

qn
string

Waterfall logger session ID

reuse
boolean

Whether to reuse an existing profile pic

scaled_crop_rect
Object

Dictionary with fractional (scaled) keys x/y/width/height for crop

x
float
y
float
width
float
height
float
set_profile_photo_shield
string

Whether to set Women in Emerging Markets Profile Photo Safety Shield on or off

sticker_id
int

Sticker ID for profile pics with sticker overlays

sticker_source_object_id
int

The FBID of the source media

width
int64

Width for crop

x
int64

Top-left x-coordinate for crop

y
int64

Top-left y-coordinate for crop

Return Type

Struct {
success: bool,
}

Validation Rules

ErrorDescription
100Invalid parameter
210User not visible
200Permissions error
240Desktop applications cannot call this function for other users
368The action attempted has been deemed abusive or is otherwise disallowed
332The image you tried to upload is too small. Please try again with a larger image.
331Your picture is too tall or too wide. Try to pick something closer to a square.
190Invalid OAuth 2.0 Access Token
121Invalid photo id

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.