Graph API Version

Page Tab

This is the Graph API endpoint for reading information about Page Tabs.

Reading

Page app tabs information

Example

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

A concatenation of the Page ID, /tabs/ and the tab app ID prefixed with app_: {page-id}/tabs/app_{app-id}

application

The app that is in the tab

custom_image_url
string

URL for an image to be used as a custom icon

custom_name
string

Name to be used for the tab

image_url
string

The location of the tab thumbnail image

is_non_connection_landing_tab
bool

A flag to identify whether the tab is a custom landing tab for users who are not connected to this Page

is_permanent
bool

A flag to identify whether the tab can be removed from the Page

link
string

A link directly to this Page tab

name
string

The tab name, which can be different from the name of the app it links to

position
unsigned int32

Where this tab is located in the list of tabs

Creating

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

Parameters

ParameterDescription
app_id
integer

The App ID for custom apps added tabs.

custom_image_url
URL

URL for an image for this tab app

custom_name
string

Custom name for this tab

is_non_connection_landing_tab
boolean

A flag to identify whether the tab is a custom landing tab for viewers who are not already connected to this Page

position
integer

Where this tab is located in the list of tabs

tab
string

The Tab key. For default apps which appear on tabs this is a value such as timeline. For custom apps this is app_{app_id}.

Return Type

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

Validation Rules

ErrorDescription
2069016Custom tab feature is restricted to use for selected pages and apps only. We require page fans>2000.
200Permissions error
100Invalid parameter
210User not visible

Updating

You can't perform this operation on this endpoint.

Deleting

You can dissociate a Tab from a Page by making a DELETE request to /{page_id}/tabs.

Parameters

ParameterDescription
tab
string

Tab key for the custom app to remove. For default tab apps this is a name such as timeline. For custom tab apps, this is app_{app_id} where {app_id} is the id of the custom app.

Required

Return Type

Struct {
success: bool,
}

Validation Rules

ErrorDescription
100Invalid parameter
200Permissions error