Graph API Version

Facebook App

A Facebook app.

Reading

A Facebook app

Permissions

  • An app access token can be used to view all fields for an app.

Examples

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

This endpoint doesn't have any parameters.

Fields

FieldDescription

id

numeric string

The app ID

an_platforms

list<enum>

The platforms associated with the app in the Audience Network product. Not enforced, but when present, it can be used to provide the user with platform specific information for the app and its placements

android_key_hash

list<string>

The app key hash for this app's Android native implementation

android_sdk_error_categories

Error configuration for Android SDK

app_ad_debug_info

App ad related information to help debugging.

app_domains

list<string>

Domains and subdomains this app can use

app_events_feature_bitmask

unsigned int32

Bitmask of on/off settings for various App Events related features

app_events_session_timeout

unsigned int32

Session timeout period in seconds for App Events

app_install_tracked

bool

Whether the app install is trackable or not

app_name

string

App name

app_type

unsigned int32

App type

auth_dialog_data_help_url

string

The URL of a special landing page that helps people who are using an app begin publishing Open Graph activity

auth_dialog_headline

string

One line description of an app that appears in the Login Dialog

auth_dialog_perms_explanation

string

The text to explain why an app needs additional permissions. This appears in the Login Dialog

auth_referral_default_activity_privacy

string

The default privacy setting selected for Open Graph activities in the Auth Dialog

auth_referral_enabled

unsigned int32

Indicates whether Authenticated Referrals are enabled

auth_referral_extended_perms

list<string>

Extended permissions that a person can choose to grant when Authenticated Referrals are enabled

auth_referral_friend_perms

list<string>

Basic friends permissions that a user must grant when Authenticated Referrals are enabled

auth_referral_response_type

string

The format that an app receives for the authentication token from the Login Dialog

auth_referral_user_perms

list<string>

Basic user permissions that a user must grant when Authenticated Referrals are enabled

canvas_fluid_height

bool

Indicates whether the app uses fluid or settable height values for Canvas

canvas_fluid_width

unsigned int32

Indicates whether the app uses fluid or fixed width values for Canvas

canvas_url

string

The non-secure URL from which Canvas app content is loaded

category

string

The category of the app

client_config

map

Config data for the client

company

string

The company the app belongs to

configured_ios_sso

bool

True if the app has configured Single Sign On on iOS

contact_email

string

Email address listed for people using the app to contact developers

context

Social context for the app

created_time

datetime

Timestamp that indicates when the app was created

creator_uid

id

User ID of the creator of this app

daily_active_users

numeric string

The number of daily active users the app has

daily_active_users_rank

unsigned int32

Ranking of this app vs other apps comparing daily active users

deauth_callback_url

string

URL that is pinged whenever a person removes the app

default_share_mode

string

The platform that should be used to share content

description

string

The description of the app, as provided by the developer

gdpv4_chrome_custom_tabs_enabled

bool

Indicates whether the user should be directed to Chrome Custom Tabs for login instead of Web View

gdpv4_enabled

bool

Indicates whether Login Version 4 is enabled for this app

gdpv4_nux_content

string

Localized content for the login new user experience

gdpv4_nux_enabled

bool

Indicates whether the New User Experience for login button must be shown or not

hosting_url

string

Webspace created with one of our hosting partners for this app

icon_url

string

The URL of this app's icon

ios_bundle_id

list<string>

Bundle ID of the associated iOS app

ios_sdk_dialog_flows

MobileSdkIOSDialogFlows

Settings for the dialog flows in the iOS SDK.

ios_sdk_error_categories

Error configuration for iOS SDK

ios_sfvc_attr

bool

Whether to support SFVC attribution for iOS SDK

ios_supports_native_proxy_auth_flow

bool

Whether to support the native proxy login flow

ios_supports_system_auth

bool

Whether to support the iOS integrated Login Dialog

ipad_app_store_id

string

ID of the app in the iPad App Store

iphone_app_store_id

string

ID of the app in the iPhone App Store

link

string

A link to the app on Facebook

logging_token

string

To use for logging purposes

logo_url

string

The URL of the app's logo

migrations

map<string, bool>

Status of migrations for this app

mobile_profile_section_url

string

Mobile URL of the app section on a person's profile

mobile_web_url

string

URL to which Mobile users will be directed when using the app

monthly_active_users

numeric string

The number of monthly active users the app has

monthly_active_users_rank

unsigned int32

Ranking of this app vs other apps comparing monthly active users

name

string

The name of the app

namespace

string

The string appended to apps.facebook.com/ to navigate to the app's canvas page

object_store_urls

Mobile store URLs for the app

page_tab_default_name

string

The title of the app when used in a Page Tab

page_tab_url

string

The non-secure URL from which Page Tab app content is loaded

privacy_policy_url

string

The URL that links to a Privacy Policy for the app

profile_section_url

string

URL of the app section on a user's profile for the desktop site

restrictions

Demographic restrictions for the app

seamless_login

bool

Does this app support seamless login for Login for Devices

secure_canvas_url

string

The secure URL from which Canvas app content is loaded

secure_page_tab_url

string

The secure URL from which Page Tab app content is loaded

server_ip_whitelist

string

App requests must originate from this comma-separated list of IP addresses

social_discovery

unsigned int32

Indicates whether app usage stories show up in the Ticker or News Feed

subcategory

string

The subcategory the app can be found under

supported_platforms

list<enum {WEB, CANVAS, MOBILE_WEB, IPHONE, IPAD, ANDROID, WINDOWS, AMAZON, SUPPLEMENTARY_IMAGES}>

All the platform the app supports

supports_apprequests_fast_app_switch

Indicates whether the app should do a fast-app-switch to the Facebook app to show the app requests dialog

supports_attribution

bool

Indicates whether the app has not opted out of app install tracking

supports_implicit_sdk_logging

bool

Indicates whether the app has not opted out of the mobile SDKs sending data on SDK interactions

suppress_native_ios_gdp

bool

Whether to suppress the native iOS Login Dialog

terms_of_service_url

string

URL to Terms of Service that appears in the Login Dialog

url_scheme_suffix

string

URL scheme suffix

user_support_email

string

Main contact email for this app where people can receive support

user_support_url

string

URL shown in the Canvas footer that people can visit to get support for the app

website_url

string

URL of a website that integrates with this app

weekly_active_users

numeric string

The number of weekly active users the app has

Edges

EdgeDescription

accounts

Test User accounts associated with the app

achievements

The full list of Games achievement types that have been registered by this app.

ads_app_insights_dimensions

Insights dimensions data for this ads app

android_dialog_configs

Configuration for dialogs used by the Android SDK.

app_event_types

Info about App Events logged for the app

app_insights

Insights data for this app

app_link_hosts

The app link hosts that are created for this app

banned

List of people banned from this app

connections

List of Open Graph Action types associated with this app

custom_audience_third_party_id

Custom audience third party ID

direct_deals

Direct deals with advertisers for this publisher app

events

Events

insights_event_labels

Insights Event Labels for this app

ios_dialog_configs

Configuration for dialogs used by the iOS SDK

moods_for_application

moods for application

object_types

Open Graph Object types associated with this app

objects

Open Graph objects

payments_test_users

The list of payment test users for the app

permissions

The status of permissions that are have been submitted for Login Review

picture

An app's profile picture.

products

In-app-purchaseable products associated with this app

purchases

In-app-purchaseable products of this app owned by the user

roles

The developer roles defined for a Facebook app.

groups

Groups that belong to this app.

insights

Insights and metrics for an object

scores

Scores from this Facebook game for a user and their friends.

staticresources

Usage statistics for any static resources used by a Facebook Canvas app.

subscriptions

The Webhooks objects that this app has subscribed to.

translations

The strings from this app that were translated using our translations tools.

Validation Rules

ErrorDescription
100Invalid parameter
3000Reading Insights of a Page/App/Domain/Event Source Group not owned by the querying user or application
3001Invalid query

Creating

You can't perform this operation on this endpoint.

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

Validation Rules

ErrorDescription
100Invalid parameter

Updating

Permissions

  • An app access token is required to update fields on an app.
You can update an Application by making a POST request to /{application_id}.

Parameters

NameDescription
an_platforms
list<enum {IOS, ANDROID, MOBILE_WEB, INSTANT_ARTICLES}>

The platforms associated with the app in the AudienceNetwork product

app_domains
list<string>

Specifies a list of domains that correspond to this app. Subdomains of domains in this array are also considered to belong to this app

app_name
string

App name

app_type
boolean

App type

auth_dialog_data_help_url
URL

The URL of a special landing page that helps users begin publishing Open Graph activity

auth_dialog_headline
string

One line description of this app that appears in the Login Dialog

auth_dialog_perms_explanation
string

The text to explain why an app needs additional permissions. This appears in the Login Dialog

auth_referral_default_activity_privacy
string

The default privacy setting selected for Open Graph activities in the Auth Dialog

auth_referral_enabled
boolean

Enables or disables Authenticated Referrals

auth_referral_extended_perms
list<string>

Extended permissions that a person can choose to grant when Authenticated Referrals are enabled

auth_referral_friend_perms
list<string>

Basic friends permissions that a person must grant when Authenticated Referrals are enabled

auth_referral_response_type
string

The format of the authentication token this app receives from the Login Dialog

auth_referral_user_perms
list<string>

Basic permissions that a person must grant when Authenticated Referrals are enabled

canvas_fluid_height
boolean

Indicates whether this app uses fluid or settable height values for Canvas

canvas_fluid_width
boolean

Indicates whether this app uses fluid or fixed width values for Canvas

canvas_url
URL

The non-secure URL from which Canvas app content is loaded

category
string

The category of this app

configured_ios_sso
boolean

Enables or disables SSO on iOS for this app

contact_email
string

Email address users can use to contact developers

created_time
time

Timestamp that indicates when this app was created

deauth_callback_url
URL

URL that is pinged whenever a person removes this app

ipad_app_store_id
string

ID of this app in the iPad App Store

iphone_app_store_id
string

ID of this app in the iPhone App Store

migrations
JSON-encoded string

Update the status of each platform migration

mobile_web_url
URL

URL that mobile users will be directed to when using this app

namespace
string

The string appended to apps.facebook.com/ to navigate to this app's Canvas page

page_tab_default_name
string

The title of this app as it appears in a Page Tab

page_tab_url
URL

The non-secure URL from which Page Tab app content is loaded

privacy_policy_url
URL

The URL that links to a privacy policy for this app

restrictions
JSON-encoded string

Update demographic restrictions for this app

secure_canvas_url
URL

The secure URL from which Canvas app content is loaded

secure_page_tab_url
URL

The secure URL from which Page Tab app content is loaded

server_ip_whitelist
list<string>

App requests must originate from this comma-separated list of IP addresses

social_discovery
boolean

Indicates whether app stories show up in ticker or News Feed

subcategory
string

The subcategory this app can be found under

terms_of_service_url
URL

URL to Terms of Service that appears in the Login Dialog

user_support_email
string

Main contact email for this app where people can receive support

user_support_url
URL

URL shown in the Canvas footer that people can visit to get support for this app

website_url
URL

URL of a website that integrates with this app

Return Type

Struct {
success: bool,
}

Validation Rules

ErrorDescription
100Invalid parameter

Deleting

You can dissociate an Application from an Application by making a DELETE request to /{application_id}/userpermissions.

Parameters

NameDescription
business
numeric string or integer

The business which owns this app

email
string

Email ID of the user

user
int

ID of the user who is being assigned a role on app

Return Type

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

Permissions

Developers usually request these permissions for this endpoint:
  • manage_pages

Parameters

This endpoint doesn't have any parameters.

Return Type

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

Validation Rules

ErrorDescription
100Invalid parameter