Graph API Version

Page Tabs

This endpoint is for created and deleting Page Tab apps.

All of these methods require a Page Access Token.

At this endpoint you can update a Page tab's position with the POST request, passing the parameter tab=TAB_NAME&position=TAB_POS.

Reading

This Page's tabs and the apps in them

Graph API Explorer
GET /v2.9/{page-id}/tabs HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
$request = new FacebookRequest(
  $session,
  'GET',
  '/{page-id}/tabs'
);
$response = $request->execute();
$graphObject = $response->getGraphObject();
/* handle the result */
/* make the API call */
FB.api(
    "/{page-id}/tabs",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{page-id}/tabs",
    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}/tabs"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

Permissions

Developers usually request these permissions for this endpoint:

Marketing Apps
No data
Page management Apps
  • manage_pages
Other Apps
No data

Parameters

NameDescription
tab
list<string>

tab

Fields

Reading from this edge will return a JSON formatted result:

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

data

A list of Tab nodes.

paging

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

Validation Rules

ErrorDescription
100Invalid parameter
200Permissions error

Creating

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

Permissions

Developers usually request these permissions for this endpoint:

Marketing Apps
  • ads_management
  • manage_pages
Page management Apps
No data
Other Apps
No data

Parameters

NameDescription
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
100Invalid parameter
200Permissions error
210User not visible

Updating

You can't perform this operation on this endpoint.

Deleting

Deleting a page tab may take up to few minutes for the action to take effect.

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

Permissions

Developers usually request these permissions for this endpoint:

Marketing Apps
  • ads_management
  • manage_pages
  • pages_show_list
Page management Apps
No data
Other Apps
No data

Parameters

NameDescription
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