Graph API Version

Page

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

Related Guides

To manage a child Page's location use the /page/locations edge.

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. A Page access token is required to view any User information for any objects owned by a Page.
  • You need to be the Admin of the 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

Example

Graph API Explorer
GET /v2.12/{page-id} 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}',
    '{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}",
    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

NameDescription
account_linking_token
UTF-8 encoded string

Short lived account linking token (5 mins expiry) to get the PSID for a user-page pair

Fields

FieldDescription
id
numeric string

Page ID. No access token is required to access this field

about
string

Information about the Page

access_token
string

The Page's access token. Only returned if the User making the request has a role (other than Live Contributor) on the Page. If your business requires two-factor authentication, the User must also be authenticated

ad_campaign

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 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

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

category_list

The Page's sub-categories

checkins
unsigned int32

Number of checkins at a place represented by a Page

company_overview
string

The company overview. Applicable to Companies

contact_address

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

Social context for this Page

copyright_attribution_insights
CopyrightAttributionInsights

Insight metrics that measures performance of copyright attribution. An example metric would be number of incremental followers from attribution

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

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

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

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 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

has_whatsapp_number
bool

has whatsapp number

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_chain
bool

Indicates whether location is part of a chain

is_community_page
bool

Indicates whether the Page is a community Page

is_eligible_for_branded_content
bool

Indicates whether the page is eligible for the branded content tool

is_messenger_bot_get_started_enabled
bool

Indicates whether the page is a Messenger Platform Bot with Get Started button enabled

is_messenger_platform_bot
bool

Indicates whether the page is a Messenger Platform Bot

is_owned
bool

Indicates whether page is owned

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

Deprecated, use "verification_status". Pages with a large number of followers can be manually verified by Facebook as [having an authentic identity] (https://www.facebook.com/help/196050490547892). This field indicates whether the page is verified by this process

Deprecated
is_webhooks_subscribed
bool

Indicates whether the application is subscribed for real time updates from this page

keywords
null

Deprecated. Returns null

Deprecated
leadgen_form_preview_details
LeadGenFormPreviewDetails

The details needed to generate an accurate preview of a lead gen form

leadgen_has_crm_integration
bool

Indicates whether this page hasApp subscribes page leads realtime update

leadgen_has_fat_ping_crm_integration
bool

Indicates whether this pagehas App that subscribes page leads realtime update via fat ping

leadgen_tos_acceptance_time
datetime

Indicates the time when the TOS for running LeadGen Ads on the page was accepted

leadgen_tos_accepted
bool

Indicates whether a user has accepted the TOS for running LeadGen Ads on the Page

leadgen_tos_accepting_user

Indicates the user who accepted the TOS for running LeadGen Ads on the page

link
string

The Page's Facebook URL

location

The location of this place. Applicable to all Places

members
string

Members of this org. Applicable to Pages representing Team Orgs

merchant_id
string

The instant workflow merchant id associated with the Page

merchant_review_status
enum

Review status of the Page against FB commerce policies, this status decides whether the Page can use component flow

messenger_ads_default_icebreakers
list<string>

The default ice breakers for a certain page

messenger_ads_default_page_welcome_message
MessengerDestinationPageWelcomeMessage

The default page welcome message for Click to Messenger Ads

messenger_ads_default_quick_replies
list<string>

The default quick replies for a certain page

messenger_ads_quick_replies_type
enum

Indicates what type this page is and we will generate different sets of quick replies based on it

mission
string

The company mission. Applicable to Companies

mpg
string

MPG of the vehicle. Applicable to Vehicles

name
string

The name of the Page

name_with_location_descriptor
string

The name of the Page with its location and/or global brand descriptor. Only visible to a page admin. Non-page admins will get the same value as name.

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

overall_star_rating
float

Overall page rating based on rating survey from users on a scale of 1-5. This value is normalized and is not guaranteed to be a strict average of user ratings.

page_token
string

page token

parent_page

Parent Page for this Page

parking

Parking information. Applicable to Businesses and Places

payment_options

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

preferred_audience

Group of tags describing the preferred audienceof ads created for the Page

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 $, $$, $$$, $$$$ 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

Boosted posts eligibility status. Only visible to a page admin

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.

rating_count
unsigned int32

Number of ratings 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

Services the restaurant provides. Applicable to Restaurants

restaurant_specialties

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

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'

verification_status
string

Showing whether this Page is verified and in what color e.g. blue verified, gray verified or not verified

voip_info

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

whatsapp_number
string

whatsapp number

written_by
string

The writer of the TV show. Applicable to TV Shows

Edges

EdgeDescription

admin_notes

Notes of this page

albums

Photo albums for this Page

assigned_users

Users assigned to this page

audio_copyrights

The music copyrights owned by this page

audio_media_copyrights

The music copyrights owned by this page (using alacorn)

blocked

User or Page Profiles blocked from this Page

broadcast_messages

broadcast messages

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

conversations

This Page's conversations

crosspost_pending_approval_pages

Pages that have not given approval for crossposting

crosspost_whitelisted_pages

Pages whitelisted for crossposting

custom_labels

custom labels

events

Events for this Page

featured_videos_collection

Featured Videos for this Page

feed

The feed of posts (including status updates) and links published by this page, or by others on this page.

global_brand_children

Children Pages of a Global Pages root Page. Both default and root Page can return children Pages

insights

This Page's Insights data

insights_exports

List of all insights reports from a Page

instant_articles

Instant articles associated with this Page

instant_articles_insights

Instant Article Aggregated Insights

labels

Labels of the Page

leadgen_conditional_questions_group

Creates conditional question

leadgen_context_cards

A library of leadgen context cards that can be reused across forms

leadgen_draft_forms

A library of lead generation draft forms created for this page

leadgen_forms

A library of lead generation forms created for this page.

leadgen_legal_content

A library of leadgen legal content that can be reused across forms.

leadgen_qualifiers

List of qualifiers available on a page, includes advertiser customized qualifiers.

leadgen_whitelisted_users

List of all whitelisted users of a page.

likes

The Pages that this Page has liked

live_videos

Live videos from this page

locations

The location Pages that are children of this Page

media_fingerprints

Media fingerprints from this page

messaging_feature_review

Feature status of the page that has been granted through feature review that show up in the page settings

messenger_ads_page_welcome_messages

Messenger page welcome messages created for a certain page

messenger_profile

messenger profile

milestones

This Page's milestones

nativeoffers

The native offers created by this Page

offers_v3

offers v3

pending_users

Users invited to access this page

personas

Messenger Platform Bot personas for the Page

photos

This Page's photos

picture

This Page's profile picture

place_topics

The place topic associated with the categories of the page

posts

The feed of posts (including status updates) and links published by this page, or by others on this page.

product_catalogs

Product catalogs owned by this page

promotable_posts

The feed of posts (including status updates) and links published by this page, or by others on this page.

published_posts

All published posts by this page

ratings

Open Graph ratings given to this Page

restaurant_orders

Food & Drink orders placed to the restaurant

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

scheduled_posts

All posts that are scheduled to a future date by a page

screennames

External accounts. Applicable to Pages representing people

seasons

Seasons for this show page

secondary_receivers

Secondary Receivers for a page

settings

Controllable settings for this page

show_playlists

Playlists for this show 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

tagged

The photos, videos, and posts in which the Page has been tagged. A derivative of /feeds

thread_settings

Messenger platform configs for the page

threads

A messages thread in Facebook Messenger

tours

tours

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

video_media_copyrights

Video copyrights from this page using alacorn

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.

visitor_posts

Shows all public posts published by page visitors on the page

workflows

Native component workflows available for this Page. Workflows allow people to perform actions like requesting appointments, buying tickets, and ordering from restaurants on Facebook.

notes

A Facebook Note created by a user or page.

notifications

page/notifications API

questions

Graph API Reference Question /question

Validation Rules

ErrorDescription
100Invalid parameter
200Permissions error
159Invalid protocol, must be https
190Invalid OAuth 2.0 Access Token
210User not visible
3001Invalid query
278Reading advertisements requires an access token with the extended permission ads_read
294Managing advertisements requires an access token with the extended permission for ads_management
270This Ads API request is not allowed for apps with development access level (Development access is by default for all apps, please request for upgrade). Make sure that the access token belongs to a user that is both admin of the app and admin of the ad account
110Invalid user id

Creating

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

Parameters

NameDescription
name
string

Name of a Persona

Required
profile_picture_url
URI

Profile picture of a Persona

Required

Return Type

Struct {
id: numeric string,
}
You can make a POST request to join_threads edge from the following paths:
When posting to this edge, a Page will be created.

Parameters

NameDescription
persona_id
Persona ID

ID of a Persona

Required
recipient_id
PSID ID

Recipient ID of Admin Text

Required

Return Type

Struct {
success: bool,
}
You can make a POST request to leadgen_forms edge from the following paths:
When posting to this edge, a Page will be created.

Parameters

NameDescription
allow_organic_lead_retrieval
boolean
Default value: true

Previously, this flag controlled whether any leads submitted in a non-Ad context were retrievable. Now this flag will not be considered and it will be deprecated entirely. To control visibility of Lead Forms in a non-Ad context you should use 'block_display_for_non_targeted_viewer'

block_display_for_non_targeted_viewer
boolean

Whether to make the organic post invisible to viewers in non-Ad context

context_card
Object

Optional context card shown as the intro page

Supports Emoji
title
UTF-8 string
Supports Emoji
style
enum {LIST_STYLE, PARAGRAPH_STYLE}
content
list<UTF-8 string>
button_text
string
context_card_id
numeric string or integer

ID of optional context card shown as the intro page

cover_photo
file

Custom cover photo for context card

custom_disclaimer
Object

Customized disclaimer including title, body content with inline links, and consent checkboxes

title
string
body
Object
text
string
Required
url_entities
list<Object>
offset
integer
Required
length
integer
Required
url
URL
Required
checkboxes
list<Object>
is_required
boolean
Default value: true
is_checked_by_default
boolean
Default value: false
text
string
Required
key
string
follow_up_action_url
URL

The final destination URL that user will go to when clicking view website button

legal_content_id
numeric string or integer

ID of EntLeadGenLegalContent

locale
enum {EN_US, IT_IT, FR_FR, ES_ES, ES_LA, DE_DE, EN_GB, PT_BR, ZH_TW, ZH_HK, TR_TR, AR_AR, CS_CZ, DA_DK, FI_FI, HE_IL, HI_IN, HU_HU, ID_ID, JA_JP, KO_KR, NB_NO, NL_NL, PL_PL, PT_PT, RO_RO, RU_RU, SV_SE, TH_TH, VI_VN, ZH_CN}

The locale of the form. Pre-defined questions renders in this locale

name
string

The name that will help identity the form

Required
privacy_policy
Object

The url and link_text of the privacy policy of advertiser

url
URL
link_text
string
question_page_custom_headline
string

The custom headline for the question page within the form

questions
list<Object>

An array of questions of the form

Required
key
string
label
string
type
enum {CUSTOM, CITY, COMPANY_NAME, COUNTRY, DOB, EMAIL, GENDER, FIRST_NAME, FULL_NAME, JOB_TITLE, LAST_NAME, MARITIAL_STATUS, PHONE, POST_CODE, PROVINCE, RELATIONSHIP_STATUS, STATE, STREET_ADDRESS, ZIP, WORK_EMAIL, MILITARY_STATUS, WORK_PHONE_NUMBER, MESSENGER, STORE_LOOKUP, DATE_TIME, ID_CPF, ID_AR_DNI, ID_CL_RUT, ID_CO_CC, ID_EC_CI, ID_PE_DNI}
Required
inline_context
string
options
list<Object>
key
string
value
string
Required
dependent_conditional_questions
list<Object>
name
string
Required
field_key
string
conditional_questions_group_id
numeric string or integer
thank_you_page
Object

Optional customized thank you page displayed post submission

title
string
Required
body
string
Required
short_message
string
button_text
string
button_description
string
business_phone_number
phone number string
enable_messenger
boolean
Default value: false
website_url
string
button_type
enum {VIEW_WEBSITE, CALL_BUSINESS, MESSAGE_BUSINESS, DOWNLOAD}
country_code
ISO 3166 Alpha Country Code
thank_you_page_id
numeric string or integer

ID of EntLeadGenThankYouPage

Return Type

This endpoint supports read-after-write and will read the node represented by id in the return type.
Struct {
id: numeric string,
}
You can make a POST request to owned_pages edge from the following paths:
When posting to this edge, a Page will be created.

Parameters

NameDescription
page_id
Page ID

page id

Required

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
access_status: string,
}
You can make a POST request to activities edge from the following paths:
When posting to this edge, a Page will be created.

Parameters

NameDescription
advertiser_tracking_enabled
boolean

If it is set to 1, then the custom events will be logged to AdConv as onsite_conversion

app_id
application ID

ID of the App which logs the event

custom_events
list<CustomEvent>

Custom events to log. Please see our app events documentation for iOS and Android for more information

_eventName
RegexParam

Name of the App Event

Required
_eventName_md5
RegexParam

MD5 hash of the event name

_valueToSum
float

Values to Sum

_logTime
int64

Time to Log

_implicitlyLogged
int64

Whether this is implicitly logged

_isTimedEvent
boolean

Whether this is a timed event

_session_id
string
_app_user_id
string
page_scoped_user_id
int64

Specifies the page scoped User ID associated with the messenger bot that logs the event

Required

Return Type

Struct {
success: bool,
}
You may perform a POST request to the following edges from this node:

Validation Rules

ErrorDescription
100Invalid parameter
210User not visible
200Permissions error
370Invalid call to update this page
371Invalid Page location update
368The action attempted has been deemed abusive or is otherwise disallowed
190Invalid OAuth 2.0 Access Token
160Invalid geolocation type
320Photo edit failure
374Invalid 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}/assigned_users.

Permissions

Developers usually request these permissions for this endpoint:

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

Parameters

NameDescription
role
enum {MANAGER, CONTENT_CREATOR, MODERATOR, ADVERTISER, INSIGHTS_ANALYST}

Page permission role to assign this user

user
int

Business user id or system user id

Required

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
}
You can update a Page by making a POST request to /{page_id}/pending_users.

Parameters

NameDescription
request_id
int

Pending user request id

Required
role
enum {MANAGER, CONTENT_CREATOR, MODERATOR, ADVERTISER, INSIGHTS_ANALYST}

Page role to assign to the pending user

Required

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
}
You can update a Page by making a POST request to /{page_id}.

Permissions

Developers usually request these permissions for this endpoint:

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

Parameters

NameDescription
about
string

Update the about field

allow_spherical_photo
boolean
Default value: false

Indicates that we should allow this photo to be treated as a spherical photo. This param will only be used when uploading a new image file. 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.

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

crossposting_pages
list<Object>

change pages permission to crosspost

page_id
Page ID
Required
allow
boolean
Required
action
enum {1, 2, 3, 4}
Required
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 { string : <> }

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
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 { enum{street, lot, valet} : <boolean> }

Update the parking field

payment_options
dictionary { enum{visa, amex, mastercard, discover, cash_only} : <boolean> }

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 { enum{reserve, walkins, groups, kids, takeout, delivery, catering, waiter, outdoor} : <boolean> }

Update the restaurant_services field

restaurant_specialties
dictionary { enum{breakfast, lunch, dinner, coffee, drinks} : <boolean> }

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.

spherical_metadata
JSON object

A set of params describing an uploaded spherical photo. This param will only be used when uploading a new image file. 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
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

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
}
You can update a Page by making a POST request to /{page_block_list_id}/pages.

Parameters

NameDescription
pages
array<Page ID>

ID of the object to add

Required

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
}
You may perform a POST request to the following edges from this node:

Validation Rules

ErrorDescription
100Invalid parameter
210User not visible
200Permissions error
370Invalid call to update this page
371Invalid Page location update
368The action attempted has been deemed abusive or is otherwise disallowed
190Invalid OAuth 2.0 Access Token
160Invalid geolocation type
320Photo edit failure
374Invalid 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

NameDescription
location_page_id
Page ID

Page ID for the page to delete

Required
store_number
int64

Store number for the page to delete

Required

Return Type

Struct {
success: bool,
}
You can dissociate a Page from a Page by making a DELETE request to /{page_id}/assigned_users.

Parameters

NameDescription
user
int

Business user id or system user id

Required

Return Type

Struct {
success: bool,
}
You can dissociate a Page from a Page by making a DELETE request to /{page_id}/pending_users.

Parameters

NameDescription
request_id
int

Pending user request id

Required

Return Type

Struct {
success: bool,
}
You can dissociate a Page from a PageBlockList by making a DELETE request to /{page_block_list_id}/pages.

Parameters

NameDescription
pages
array<Page ID>

ID of the object to remove

Required

Return Type

Struct {
success: bool,
}
You may perform a DELETE request to the following edges from this node:

Validation Rules

ErrorDescription
200Permissions error
190Invalid OAuth 2.0 Access Token
100Invalid parameter