Page

Graph API Version

v2.7

This represents a Facebook Page. The /{page-id} node returns a single page.

Related Guides

Reading

A Facebook page

Permissions

For pages that are published, you need:

An app or user access token to view fields from fully public pages.
A user access token to view fields from restricted pages that this person is able to view (such as those restrict to certain demographics like location or age, or those only viewable by Page admins).
A page access token can also be used to view those restricted fields.
You need to be the admin of root page for child pages in order to read the global_brand_children edge for a page.

For pages that are not published, you need:

To have the admin role for the page
A page access token

Examples

Graph API Explorer

GET /v2.7/{page-id} HTTP/1.1
Host: graph.facebook.com

/* PHP SDK v5.0.0 */
/* make the API call */
$request = new FacebookRequest(
  $session,
  'GET',
  '/{page-id}'
);
$response = $request->execute();
$graphObject = $response->getGraphObject();
/* handle the result */

/* make the API call */
FB.api(
    "/{page-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{page-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:@"/{page-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

Name	Description
`account_linking_token` Base64 UTF-8 encoded string	Short lived account linking token (5 mins expiry) to get the PSID for a user-page pair

Fields

Field	Description
`id` numeric string	Page ID. No access token is required to access this field Core
`about` string	Information about the Page
`access_token` string	The access token you can use to act as the Page. Only visible to Page Admins
`ad_campaign` AdCampaign	The Page's currently running promotion campaign
`affiliation` string	Affiliation of this person. Applicable to Pages representing people
`app_id` id	App ID for app-owned Pages and app Pages
`app_links` AppLinks	AppLinks data associated with the Page's URL
`artists_we_like` string	Artists the band likes. Applicable to Bands
`attire` string	Dress code of the business. Applicable to Restaurants or Nightlife. Can be one of Casual, Dressy or Unspecified
`awards` string	The awards information of the film. Applicable to Films
`band_interests` string	Band interests. Applicable to Bands
`band_members` string	Members of the band. Applicable to Bands
`best_page` Page	The best available Page on Facebook for the concept represented by this Page. The best available Page takes into account authenticity and the number of likes
`bio` string	Biography of the band. Applicable to Bands
`birthday` string	Birthday of this person. Applicable to Pages representing people
`booking_agent` string	Booking agent of the band. Applicable to Bands
`built` string	Year vehicle was built. Applicable to Vehicles
`business`	The Business associated with this Page. Visible only with a page access token or a user access token that has admin rights on the page
`can_checkin` bool	Whether this page has checkin functionality enabled
`can_post` bool	Whether the current session user can post on this Page
`category` string	The Page's category. e.g. Product/Service, Computers/Technology Core
`category_list` list<PageCategory>	The Page's sub-categories
`checkins` unsigned int32	Number of checkins at a place represented by a Page Core
`company_overview` string	The company overview. Applicable to Companies
`contact_address` MailingAddress	The mailing or contact address for this page. This field will be blank if the contact address is the same as the physical address
`context` OpenGraphContext	Social context for this Page
`country_page_likes` unsigned int32	If this is a Page in a Global Pages hierarchy, the number of people who are being directed to this Page.
`cover` CoverPhoto	Information about the page's cover photo
`culinary_team` string	Culinary team of the business. Applicable to Restaurants or Nightlife
`current_location` string	Current location of the Page
`description` string	The description of the Page Core
`description_html` string	The description of the Page in raw HTML
`directed_by` string	The director of the film. Applicable to Films
`display_subtext` string	Subtext about the Page being viewed
`displayed_message_response_time` string	Page estimated message response time displayed to user
`emails` list<string>	The emails listed in the About section of a Page
`engagement` Engagement	The social sentence and like count information for this Page. This is the same info used for the like button
`fan_count` unsigned int32	The number of users who like the Page. For Global Pages this is the count for all Pages across the brand.
`featured_video` Video	Video featured by the Page
`features` string	Features of the vehicle. Applicable to Vehicles
`food_styles` list<string>	The restaurant's food styles. Applicable to Restaurants
`founded` string	When the company was founded. Applicable to Pages in the Company category
`general_info` string	General information provided by the Page
`general_manager` string	General manager of the business. Applicable to Restaurants or Nightlife
`genre` string	The genre of the film. Applicable to Films
`global_brand_page_name` string	The name of the Page with country codes appended for Global Pages. Only visible to the Page admin
`global_brand_root_id` numeric string	This brand's global Root ID
`has_added_app` bool	Indicates whether this Page has added the app making the query in a Page tab
`hometown` string	Hometown of the band. Applicable to Bands
`hours` map<string, string>	Indicates a single range of opening hours for a day. Each day can have 2 different hours ranges. The keys in the map are in the form of `{day}_{number}_{status}`. `{day}` should be the first 3 characters of the day of the week, `{number}` should be either 1 or 2 to allow for the two different hours ranges per day. `{status}` should be either `open` or `close` to delineate the start or end of a time range. An example would be `mon_1_open` with value `17:00` and `mon_1_close` with value `21:15` which would represent a single opening range of 5pm to 9:15pm on Mondays
`impressum` string	Legal information about the Page publishers
`influences` string	Influences on the band. Applicable to Bands
`instant_articles_review_status` enum	Indicates the current Instant Articles review status for this page
`is_always_open` bool	Indicates whether this location is always open
`is_community_page` bool	Indicates whether the Page is a community Page
`is_permanently_closed` bool	Whether the business corresponding to this Page is permanently closed
`is_published` bool	Indicates whether the Page is published and visible to non-admins
`is_unclaimed` bool	Indicates whether the Page is unclaimed
`is_verified` bool	Pages with a large number of followers can be manually verified by Facebook as having an authentic identity. This field indicates whether the page is verified by this process
`is_webhooks_subscribed` bool	Indicates whether the application is subscribed for real time updates from this page
`keywords` null	Deprecated. Returns null Deprecated
`leadgen_tos_accepted` bool	Indicates whether a user has accepted the TOS for running LeadGen Ads on the Page
`link` string	The Page's Facebook URL Core
`location` Location	The location of this place. Applicable to all Places
`members` string	Members of this org. Applicable to Pages representing Team Orgs
`mission` string	The company mission. Applicable to Companies
`mpg` string	MPG of the vehicle. Applicable to Vehicles
`name` string	The name of the Page Core Default
`name_with_location_descriptor` string	The name of the Page with its location and/or global brand descriptor
`network` string	The TV network for the TV show. Applicable to TV Shows
`new_like_count` unsigned int32	The number of people who have liked the Page, since the last login. Only visible to a page admin
`offer_eligible` bool	Offer eligibility status. Only visible to a page admin
`parent_page` Page	Parent Page for this Page
`parking` PageParking	Parking information. Applicable to Businesses and Places
`payment_options` PagePaymentOptions	Payment options accepted by the business. Applicable to Restaurants or Nightlife
`personal_info` string	Personal information. Applicable to Pages representing People
`personal_interests` string	Personal interests. Applicable to Pages representing People
`pharma_safety_info` string	Pharmacy safety information. Applicable to Pharmaceutical companies
`phone` string	Phone number provided by a Page
`place_type` enum	For places, the category of the place
`plot_outline` string	The plot outline of the film. Applicable to Films
`press_contact` string	Press contact information of the band. Applicable to Bands
`price_range` string	Price range of the business. Applicable to Restaurants or Nightlife. Can be one of `$` (0-10), `$$` (10-30), `$$$` (30-50), `$$$$` (50+) or `Unspecified`
`produced_by` string	The productor of the film. Applicable to Films
`products` string	The products of this company. Applicable to Companies
`promotion_eligible` bool	Reason why a post isn't eligible for boosting. Only visible to Page Admins
`promotion_ineligible_reason` string	Reason, for which boosted posts are not eligible. Only visible to a page admin
`public_transit` string	Public transit to the business. Applicable to Restaurants or Nightlife
`publisher_space` PublisherSpace	Publisher Space for the page.
`recipient` numeric string	Messenger page scope id associated with page and a user using account_linking_token
`record_label` string	Record label of the band. Applicable to Bands
`release_date` string	The film's release date. Applicable to Films
`restaurant_services` PageRestaurantServices	Services the restaurant provides. Applicable to Restaurants
`restaurant_specialties` PageRestaurantSpecialties	The restaurant's specialties. Applicable to Restaurants
`schedule` string	The air schedule of the TV show. Applicable to TV Shows
`screenplay_by` string	The screenwriter of the film. Applicable to Films
`season` string	The season information of the TV Show. Applicable to TV Shows
`single_line_address` string	The page address, if any, in a simple single line format.
`starring` string	The cast of the film. Applicable to Films
`start_info` PageStartInfo	Information about when the entity represented by the Page was started
`store_location_descriptor` string	Location Page's store location descriptor
`store_number` unsigned int32	Unique store number for this location Page
`studio` string	The studio for the film production. Applicable to Films
`supports_instant_articles` bool	Indicates whether this Page supports Instant Articles
`talking_about_count` unsigned int32	The number of people talking about this Page
`unread_message_count` unsigned int32	Unread message count for the Page. Only visible to a page admin
`unread_notif_count` unsigned int32	Number of unread notifications. Only visible to a page admin
`unseen_message_count` unsigned int32	Unseen message count for the Page. Only visible to a page admin
`username` string	The alias of the Page. For example, for www.facebook.com/platform the username is 'platform' Core
`verification_status` string	Showing whether this Page is verified and in what color e.g. blue verified, gray verified or not verified
`voip_info` VoipInfo	Voip info
`website` string	The URL of the Page's website
`were_here_count` unsigned int32	The number of visits to this Page's location. If the Page setting Show map, check-ins and star ratings on the Page (under Page Settings > Page Info > Address) is disabled, then this value will also be disabled
`written_by` string	The writer of the TV show. Applicable to TV Shows

Edges

Edge	Description
`admin_notes`	Notes of this page
`albums`	Photo albums for this Page
`blocked`	User or Page Profiles blocked from this Page
`business_activities`	The business activities related to this page
`call_to_actions`	The call-to-action created by this Page
`canvas_elements`	The canvas elements associated with this page
`events`	Events for this Page
`featured_videos_collection`	Featured Videos for this Page.
`global_brand_children`	Children Pages of a Global Page's root Page. Only root Page can return children Pages.
`insights`	This Page's Insights data. Global brand default Page will return its own insights data, while root Page will return integrated insights of the whole hierarchy.
`instant_articles`	Instant articles associated with this Page
`instant_articles_insights`	Instant Article Aggregated Insights
`labels`	Labels of the Page
`leadgen_whitelisted_users`	List of all whitelisted users of a page.
`likes`	The Pages that this Page Likes.
`live_videos`	Live videos from this page
`locations`	The location Pages that are children of this Page
`milestones`	This Page's milestones
`nativeoffers`	The native offers created by this Page
`offers`	The offers created by this Page
`photos`	This Page's photos
`picture`	This Page's profile picture
`place_topics`	The place topic associated with the categories of the page
`product_catalogs`	Product catalogs owned by this page
`ratings`	Open Graph ratings given to this Page
`roles`	The Page's Admins
`saved_filters`	Filters saved in Page Publishing Tools
`saved_message_responses`	All message responses that are saved by a page
`screennames`	External accounts. Applicable to Pages representing people
`settings`	Controllable settings for this page
`subscribed_apps`	Applications that have real time update subscriptions for this Page. Note that we will only return information about the current app
`tabs`	This Page's tabs and the apps in them
`video_broadcasts`	Video broadcasts from this page
`video_copyright_rules`	Video copyright rules from this page
`video_copyrights`	Video copyrights from this page
`video_lists`	Video Playlists for this Page
`videos`	Videos for this Page
`videos_you_can_use`	Provides a list of videos the Page can use for crossposting. Owners of these videos have granted permission for the Page to crosspost them.
`conversations`	The Facebook Messages conversations that this Page is involved in.
`feed`	The feed of posts (including status updates) and links published by this page, or by others on this page.
`notes`	A Facebook Note created by a user or page.
`notifications`	page/notifications API
`posts`	The feed of posts (including status updates) and links published by this page, or by others on this page.
`promotable_posts`	The feed of posts (including status updates) and links published by this page, or by others on this page.
`questions`	Graph API Reference Question /question
`statuses`	The feed of status messages published by this page.
`threads`	A messages thread in Facebook Messenger

Validation Rules

Error	Description
100	Invalid parameter
210	User not visible
3001	Invalid query
275	Cannot determine the target object for this request. Currently supported objects include ad account, business account and associated objects.
10300	Param account_linking_token is required
10301	Account linking token expired
278	Reading advertisements requires an access token with the extended permission ads_read
114	Invalid user id list

Creating

Applications with Standard API Access can create Pages through the API using the following paths:

/{user_id}/accounts

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

/{business_id}/pages

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

Permissions

Developers usually request these permissions for this endpoint:

manage_pages
business_management

Parameters

Name	Description
`access_type` enum {OWNER, AGENCY}	access type Required
`page_id` int	page id Required
`permitted_roles` list<enum {MANAGER, CONTENT_CREATOR, MODERATOR, ADVERTISER, INSIGHTS_ANALYST}>	permitted roles

Return Type

Struct {

access_status: string,

}

You may perform a POST request to the following edges from this node:

Validation Rules

Error	Description
210	User not visible
100	Invalid parameter
371	Invalid Page location update
320	Photo edit failure
374	Invalid store location descriptor update since this Page is not a location Page.

Updating

You can update a Page by making a POST request to /{page_id}.

Permissions

Developers usually request these permissions for this endpoint:

manage_pages
publish_pages

Parameters

Name	Description
`about` string	Update the `about` field
`attire` enum{Unspecified, Casual, Dressy}	Update the `attire` field
`bio` string	Update the `bio` field
`category_list` list<numeric string>	Update the `category_list` field
`company_overview` string	Update the `company_overview` field
`contact_address` Object	Update the `contact_address` field
`city_id` city id
`street1` string
`street2` string
`zip` string
`cover` numeric string or integer	Update the `cover` field
`culinary_team` string	Update the `culinary_team` field
`description` string	Update the `description` field
`directed_by` string	Update the `directed_by` field
`displayed_message_response_time` string	Page estimated message response time displayed to user
`emails` list<string>	Update the `emails` field
`focus_x` float	Cover photo focus x
`focus_y` float	Cover photo focus y
`food_styles` list<enum{Afghani, American (New), American (Traditional), Asian Fusion, Barbeque, Brazilian, Breakfast, British, Brunch, Buffets, Burgers, Burmese, Cajun/Creole, Caribbean, Chinese, Creperies, Cuban, Delis, Diners, Ethiopian, Fast Food, Filipino, Fondue, Food Stands, French, German, Greek and Mediterranean, Hawaiian, Himalayan/Nepalese, Hot Dogs, Indian/Pakistani, Irish, Italian, Japanese, Korean, Latin American, Mexican, Middle Eastern, Moroccan, Pizza, Russian, Sandwiches, Seafood, Singaporean, Soul Food, Southern, Spanish/Basque, Steakhouses, Sushi Bars, Taiwanese, Tapas Bars, Tex-Mex, Thai, Turkish, Vegan, Vegetarian, Vietnamese}>	Update the `food_styles` field
`general_info` string	Update the `general_info` field
`general_manager` string	Update the `general_manager` field
`genre` string	Update the `genre` field
`hours` dictionary	Update the `hours` field
`ignore_coordinate_warnings` boolean	Ignore coordinate warnings when updating this Page's location
`impressum` string	Update the `impressum` field
`instant_articles_submit_for_review` boolean	Submit Instant Articles on the Page for review
`is_always_open` boolean	Is this location always open?
`is_permanently_closed` boolean	Update the `is_permanently_closed` field
`is_published` boolean	Update the `is_published` field
`is_webhooks_subscribed` boolean	Is the application subscribed for real time updates from this page?
`location` Object	Update the `location` field
`city` string
`city_id` city id
`state` string
`country` string
`street` string
`zip` string
`latitude` float
`longitude` float
`menu` Base64 UTF-8 encoded string	Menu information for pages. Only applicable if the page is a restaurant/cafe/etc., can be a URL to the menu page, a URL for a photo, or a structured text blob (which can contain information such as price, portions and photo)
`mission` string	Update the `mission` field
`no_feed_story` boolean	Default value: `false` Don't generate a feed story for the cover photo
`no_notification` boolean	Default value: `false` Don't generate a notification for the cover photo
`offset_x` integer	Default value: `50` Cover photo offset x
`offset_y` integer	Default value: `50` Cover photo offset y
`parking` dictionary	Update the `parking` field
`payment_options` dictionary	Update the `payment_options` field
`phone` string	Update the `phone` field
`plot_outline` string	Update the `plot_outline` field
`price_range` string	Update the `price_range` field
`public_transit` string	Update the `public_transit` field
`restaurant_services` dictionary	Update the `restaurant_services` field
`restaurant_specialties` dictionary	Update the `restaurant_specialties` field
`scrape` boolean	Re-scrape the website associated with this Page
`service_details` string	Details of services provided by page. Can include delivery status/area/hours for the page.
`start_info` Object	Update the `start_info` field
`type` enum{Unspecified, Born, Founded, Started, Opened, Created, Launched}	Required
`date` Object
`year` integer
`month` integer
`day` integer
`store_location_descriptor` string	Update the `store_location_descriptor` field
`website` URL	Update the `website` field
`zoom_scale_x` float	Cover photo zoom scale x
`zoom_scale_y` float	Cover photo zoom scale y

Return Type

Struct {

success: bool,

}

You may perform a POST request to the following edge from this node:

/{page_id}/leadgen_whitelisted_users

Validation Rules

Error	Description
210	User not visible
100	Invalid parameter
371	Invalid Page location update
320	Photo edit failure
374	Invalid store location descriptor update since this Page is not a location Page.

Deleting

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

Parameters

Name	Description
`location_page_id` int	Page ID for the page to delete Required
`store_number` unsigned int32	Store number for the page to delete Required

Return Type

Struct {

success: bool,

}

You may perform a DELETE request to the following edges from this node:

Validation Rules

Error	Description
210	User not visible