Appearance
Fresh 2026
Facebook App
A Facebook app.
Reading
Get information about a Facebook app.
Permissions
- An app access token can be used to view all fields for an app.
Example
HTTPPHP SDKJavaScript SDKAndroid SDKiOS SDK Graph API Explorer
GET /v25.0/{application-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(
'/{application-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(
"/{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();/* 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
| Field | Description |
|---|---|
id<br>numeric string | The app ID<br>Core |
aam_rules<br>string | Rules of Auto Advanced Matching in FB SDKs |
an_ad_space_limit<br>unsigned int32 | The maximum number of Ad Spaces allowed for each Audience Network supported platform |
an_platforms<br>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 |
app_domains<br>list<string> | Domains and subdomains this app can use |
app_events_config<br>ApplicationAppEventsConfig | Configuration for app events |
app_install_tracked<br>bool | Whether the app install is trackable or not |
app_name<br>string | App name |
app_signals_binding_ios<br>list<Binding> | List of app event bindings for iOS app |
app_type<br>unsigned int32 | App type |
auth_dialog_data_help_url<br>string | The URL of a special landing page that helps people who are using an app begin publishing Open Graph activity |
auth_dialog_headline<br>string | One line description of an app that appears in the Login Dialog |
auth_dialog_perms_explanation<br>string | The text to explain why an app needs additional permissions. This appears in the Login Dialog |
auth_referral_default_activity_privacy<br>string | The default privacy setting selected for Open Graph activities in the Auth Dialog |
auth_referral_enabled<br>unsigned int32 | Indicates whether Authenticated Referrals are enabled |
auth_referral_extended_perms<br>list<string> | Extended permissions that a person can choose to grant when Authenticated Referrals are enabled |
auth_referral_friend_perms<br>list<string> | Basic friends permissions that a user must grant when Authenticated Referrals are enabled |
auth_referral_response_type<br>string | The format that an app receives for the authentication token from the Login Dialog |
auth_referral_user_perms<br>list<string> | Basic user permissions that a user must grant when Authenticated Referrals are enabled |
canvas_fluid_height<br>bool | Indicates whether the app uses fluid or settable height values for Canvas |
canvas_fluid_width<br>unsigned int32 | Indicates whether the app uses fluid or fixed width values for Canvas |
canvas_url<br>string | The non-secure URL from which Canvas app content is loaded |
category<br>string | The category of the app<br>Default |
client_config<br>map | Config data for the client |
company<br>string | The company the app belongs to |
configured_ios_sso<br>bool | True if the app has configured Single Sign On on iOS |
contact_email<br>string | Email address listed for people using the app to contact developers |
created_time<br>datetime | Timestamp that indicates when the app was created |
creator_uid<br>id | User ID of the creator of this app |
daily_active_users<br>numeric string | The number of daily active users the app has |
daily_active_users_rank<br>unsigned int32 | Ranking of this app vs other apps comparing daily active users |
deauth_callback_url<br>string | URL that is pinged whenever a person removes the app |
default_share_mode<br>string | The platform that should be used to share content |
description<br>string | The description of the app, as provided by the developer<br>Core |
financial_id<br>string | The ID for the corresponding audience network financial entity. |
hosting_url<br>string | Webspace created with one of our hosting partners for this app |
icon_url<br>string | The URL of this app's icon |
ios_bundle_id<br>list<string> | Bundle ID of the associated iOS app |
ios_supports_native_proxy_auth_flow<br>bool | Whether to support the native proxy login flow |
ios_supports_system_auth<br>bool | Whether to support the iOS integrated Login Dialog |
ipad_app_store_id<br>string | ID of the app in the iPad App Store |
iphone_app_store_id<br>string | ID of the app in the iPhone App Store |
latest_sdk_version<br>ApplicationSDKInfo | App latest sdk version |
link<br>string | A link to the app on Facebook<br>Core Default |
logging_token<br>string | To use for logging purposes |
logo_url<br>string | The URL of the app's logo |
migrations<br>map<string, bool> | Status of migrations for this app |
mobile_profile_section_url<br>string | Mobile URL of the app section on a person's profile |
mobile_web_url<br>string | URL to which Mobile users will be directed when using the app |
monthly_active_users<br>numeric string | The number of monthly active users the app has |
monthly_active_users_rank<br>unsigned int32 | Ranking of this app vs other apps comparing monthly active users |
name<br>string | The name of the app<br>Core Default |
namespace<br>string | The string appended to apps.facebook.com/ to navigate to the app's canvas page<br>Core Default |
object_store_urls<br>ApplicationObjectStoreURLs | Mobile store URLs for the app |
page_tab_default_name<br>string | The title of the app when used in a Page Tab |
page_tab_url<br>string | The non-secure URL from which Page Tab app content is loaded |
photo_url<br>string | The URL of the app photo |
privacy_policy_url<br>string | The URL that links to a Privacy Policy for the app |
profile_section_url<br>string | URL of the app section on a user's profile for the desktop site |
property_id<br>string | The monetization property which owns this app |
protected_mode_rules<br>ApplicationProtectedModeRules | protected_mode_rules |
real_time_mode_devices<br>list<string> | List of real time hashed device |
restrictions<br>ApplicationRestrictionInfo | Demographic restrictions for the app |
restrictive_data_filter_params<br>string | Params used to filter out restrictive data |
secure_canvas_url<br>string | The secure URL from which Canvas app content is loaded |
secure_page_tab_url<br>string | The secure URL from which Page Tab app content is loaded |
server_ip_whitelist<br>string | App requests must originate from this comma-separated list of IP addresses |
social_discovery<br>unsigned int32 | Indicates whether app usage stories show up in the Ticker or Feed |
subcategory<br>string | The subcategory the app can be found under |
suggested_events_setting<br>string | Settings for suggested events |
supported_platforms<br>list<enum {WEB, CANVAS, MOBILE_WEB, IPHONE, IPAD, ANDROID, WINDOWS, AMAZON, SUPPLEMENTARY_IMAGES, GAMEROOM, INSTANT_GAME, OCULUS, SAMSUNG, XIAOMI}> | All the platform the app supports |
terms_of_service_url<br>string | URL to Terms of Service that appears in the Login Dialog |
url_scheme_suffix<br>string | URL scheme suffix |
user_support_email<br>string | Main contact email for this app where people can receive support |
user_support_url<br>string | URL shown in the Canvas footer that people can visit to get support for the app |
website_url<br>string | URL of a website that integrates with this app |
weekly_active_users<br>numeric string | The number of weekly active users the app has |
Edges
| Edge | Description |
|---|---|
accounts<br>Edge<TestAccount> | Test User accounts associated with the app |
ad_placement_groups<br>Edge<AdPlacementGroup> | Ad placement groups for publishing ads on this app |
adnetworkanalytics_results<br>Edge<AdNetworkAnalyticsAsyncQueryResult> | Obtain the results of an async Audience Network query for this publisher entity |
aem_attribution<br>Edge<AEMAttribution> | aem_attribution |
aem_conversion_configs<br>Edge<AEMConversionConfig> | The aggregated event measurement conversion value configs for this app |
aem_conversion_filter<br>Edge<AEMConversionFilter> | Boolean for if product_set_id [fb_content_id] belongs to a certain catalog [catalog_id] |
agencies<br>Edge<Business> | The businesses which are not owner but can advertise for this app |
app_event_types<br>Edge<ApplicationAppEventTypes> | Info about App Events logged for the app |
app_installed_groups<br>Edge<Group> | List of facebook groups the app is installed in |
appassets<br>Edge<CanvasAppAsset> | appassets |
button_auto_detection_device_selection<br>Edge<ButtonAutoDetectionDeviceSelection> | Whether to turn on auto device sampling. |
cloudbridge_settings<br>Edge<CloudbridgeSetting> | cloudbridge_settings |
connected_client_businesses<br>Edge<Business> | connected_client_businesses |
da_checks<br>Edge<DACheck> | A list of results after running Dynamic Ads checks on this app. |
ios_skadnetwork_conversion_config<br>Edge<ConversionConfig> | ios_skadnetwork_conversion_config |
mobile_sdk_gk<br>Edge<MobileSdkGk> | Gatekeeper for Mobile SDK |
model_asset<br>Edge<SDKMLModel> | model_asset |
monetized_digital_store_objects<br>Edge<MonetizedDigitalStoreObject> | List of digital store objects for this app monetized via Audience Network |
object_types<br>Edge<Null> | Open Graph Object types associated with this app |
objects<br>Edge<Null> | Open Graph objects |
permissions<br>Edge<ApplicationPermission> | The status of permissions that are have been submitted for Login Review |
products<br>Edge<GamesIAPProduct> | In-app-purchaseable products associated with this app |
purchases<br>Edge<GamesIAPOrder> | In-app-purchaseable products of this app owned by the user |
roles<br>Edge<ApplicationRoles> | The developer roles defined for this app |
sgw_dataset_status<br>Edge<ApplicationSgwDatasetStatus> | sgw_dataset_status |
sgw_install_deferral_link<br>Edge<ApplicationSgwInstallDeferralLink> | sgw_install_deferral_link |
threat_privacy_groups_member<br>Edge<ThreatPrivacyGroup> | The privacy groups of which this app is the member |
threat_privacy_groups_owner<br>Edge<ThreatPrivacyGroup> | The privacy groups of which this app is the owner |
whatsapp_business_solutions<br>Edge<WhatsAppBusinessSolution> | Lists the WhatsApp Business Partner Solution objects that the application participate in. |
Error Codes
| Error | Description |
|---|---|
| 100 | Invalid parameter |
| 190 | Invalid OAuth 2.0 Access Token |
| 459 | The session is invalid because the user has been checkpointed |
| 368 | The action attempted has been deemed abusive or is otherwise disallowed |
| 200 | Permissions error |
| 105 | The number of parameters exceeded the maximum for this operation |
| 3000 | Reading insights of a Page, business, app, domain or event source group not owned by the querying user or application |
| 483 | The session is invalid because the user is in consent app blocking |
| 2500 | Error parsing graph query |
| 104 | Incorrect signature |
Creating
You can make a POST request to owned_apps edge from the following paths:
/{business_id}/owned_apps
When posting to this edge, an Application will be created.
Parameters
This endpoint doesn't have any parameters.
Return Type
This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
access_status: string,
}
Error Codes
| Error | Description |
|---|---|
| 200 | Permissions error |
You can make a POST request to app_indexing edge from the following paths:
/{application_id}/app_indexing
When posting to this edge, an Application will be created.
Parameters
| Parameter | Description |
|---|---|
app_version<br>string | The version of the app being indexed<br>Required |
device_session_id<br>string | Device session id of the uploading device |
extra_info<br>string | Extra information about the app index |
platform<br>enum {ANDROID, IOS} | The platform of the app being indexed<br>Required |
request_type<br>enum {APP_INDEXING, PLUGIN, BUTTON_SAMPLING} | Default value: "APP_INDEXING"<br>Type of the app indexing request |
tree<br>JSON object | The UI component tree of the app<br>Required |
screenname<br>string | |
screenshot<br>string | |
view<br>list<JSON encoded app UI component> | Required |
Return Type
Struct {
success: bool,
is_app_indexing_enabled: bool,
}
Error Codes
| Error | Description |
|---|---|
| 100 | Invalid parameter |
You can make a POST request to codeless_event_mappings edge from the following paths:
/{application_id}/codeless_event_mappings
When posting to this edge, an Application will be created.
Parameters
| Parameter | Description |
|---|---|
mappings<br>array<JSON object> | The event to UI component mappings of the app<br>Required |
method<br>enum {INFERENCE, MANUAL, CONFIRMED_INFERENCE, BUTTON_INDEXING, UNKNOWN} | method<br>Required |
event_name<br>string | event_name<br>Required |
event_type<br>enum {CLICK, SELECTED, TEXT_CHANGED} | event_type<br>Required |
app_version<br>string | app_version<br>Required |
parameters<br>array<JSON object> | parameters |
name<br>string | name<br>Required |
path<br>array<JSON object> | path<br>Required |
class_name<br>string | class_name<br>Required |
index<br>int64 | index<br>Required |
id<br>int64 | id |
text<br>string | text |
tag<br>string | tag |
description<br>string | description |
hint<br>string | hint |
match_bitmask<br>int64 | match_bitmask |
path_type<br>enum {ABSOLUTE, RELATIVE} | Default value: "ABSOLUTE"<br>path_type |
component_id<br>string | component_id<br>Required |
path<br>array<JSON object> | path<br>Required |
class_name<br>string | class_name<br>Required |
index<br>int64 | index<br>Required |
id<br>int64 | id |
text<br>string | text |
tag<br>string | tag |
description<br>string | description |
hint<br>string | hint |
match_bitmask<br>int64 | match_bitmask |
component_id<br>string | component_id<br>Required |
path_type<br>enum {ABSOLUTE, RELATIVE} | Default value: "ABSOLUTE"<br>path_type |
screenshot_handle<br>string | screenshot_handle |
dimensions<br>array<JSON object> | dimensions |
top<br>int64 | top<br>Required |
left<br>int64 | left<br>Required |
width<br>int64 | width<br>Required |
height<br>int64 | height<br>Required |
activity_name<br>string | activity_name |
mutation_method<br>enum {REPLACE, ADD, DELETE} | Detailed mutation type like replace, add<br>Required |
platform<br>enum {ANDROID, IOS} | The platform of the app being indexed<br>Required |
post_method<br>enum {EYMT, CODELESS} | Default value: "CODELESS"<br>Whether the api is called by codeless or EYMT |
Return Type
Struct {
num_updated: int32,
num_invalid: int32,
}
Error Codes
| Error | Description |
|---|---|
| 105 | The number of parameters exceeded the maximum for this operation |
You can make a POST request to client_apps edge from the following paths:
/{business_id}/client_apps
When posting to this edge, an Application will be created.
Parameters
| Parameter | Description |
|---|---|
app_id | App ID.<br>Required |
Return Type
This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
access_status: enum,
}
Error Codes
| Error | Description |
|---|---|
| 100 | Invalid parameter |
Updating
Update application information such as demographic restrictions.
Permissions
- An app access token is required to update fields on an app.
Example
To update an app restrictions, such as age, send a POST request to /{app-id}:
curl -i -X POST "https://graph.facebook.com/{app-id}?restrictions={'age':'21+'}&access_token={app-access-token}"
On success your app receives this response:
{ "success": true }
You can update an Application by making a POST request to /{application_id}.
Parameters
| Parameter | Description |
|---|---|
allow_cycle_app_secret<br>boolean | Default value: false<br>Allows for the application to cycle the secret |
an_platforms<br>list<enum {ANDROID, CTV, DESKTOP, GALAXY, INSTANT_ARTICLES, IOS, MOBILE_WEB, OCULUS, UNKNOWN, XIAOMI}> | The platforms associated with the app in the AudienceNetwork product |
app_domains<br>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<br>string | App name |
app_type<br>boolean | App type |
auth_dialog_headline<br>string | One line description of this app that appears in the Login Dialog |
auth_dialog_perms_explanation<br>string | The text to explain why an app needs additional permissions. This appears in the Login Dialog |
auth_referral_enabled<br>boolean | Enables or disables Authenticated Referrals |
auth_referral_extended_perms<br>list<string> | Extended permissions that a person can choose to grant when Authenticated Referrals are enabled |
auth_referral_friend_perms<br>list<string> | Basic friends permissions that a person must grant when Authenticated Referrals are enabled |
auth_referral_response_type<br>string | The format of the authentication token this app receives from the Login Dialog |
auth_referral_user_perms<br>list<string> | Basic permissions that a person must grant when Authenticated Referrals are enabled |
canvas_fluid_height<br>boolean | Indicates whether this app uses fluid or settable height values for Canvas |
canvas_fluid_width<br>boolean | Indicates whether this app uses fluid or fixed width values for Canvas |
canvas_url<br>URL | The non-secure URL from which Canvas app content is loaded |
contact_email<br>string | Email address users can use to contact developers |
deauth_callback_url<br>URL | URL that is pinged whenever a person removes this app |
mobile_web_url<br>URL | URL that mobile users will be directed to when using this app |
namespace<br>string | The string appended to apps.facebook.com/ to navigate to this app's Canvas page |
page_tab_default_name<br>string | The title of this app as it appears in a Page Tab |
privacy_policy_url<br>URL | The URL that links to a privacy policy for this app |
restrictions<br>JSON-encoded string | Update demographic restrictions for this app. Can be one or more of the following parameters: age, location, or type. age can be one of the following values: 13+, 16+, 17+, 18+, 19+, or 21+. location can be one or more country represented by the 2 letter country code. type can only be alcohol. |
secure_canvas_url<br>URL | The secure URL from which Canvas app content is loaded |
secure_page_tab_url<br>URL | The secure URL from which Page Tab app content is loaded |
server_ip_whitelist<br>list<string> | App requests must originate from this comma-separated list of IP addresses |
terms_of_service_url<br>URL | URL to Terms of Service that appears in the Login Dialog |
url_scheme_suffix<br>string | URL scheme suffix |
user_support_email<br>string | Main contact email for this app where people can receive support |
user_support_url<br>URL | URL shown in the Canvas footer that people can visit to get support for this app |
website_url<br>URL | URL of a website that integrates with this app |
Return Type
This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
}
Error Codes
| Error | Description |
|---|---|
| 100 | Invalid parameter |
| 104 | Incorrect signature |
| 368 | The action attempted has been deemed abusive or is otherwise disallowed |
You can update an Application by making a POST request to /act_{ad_account_id}/subscribed_apps.
Parameters
| Parameter | Description |
|---|---|
app_id<br>string | Default value: ``<br>the id of app to be subscribed from ad account |
Return Type
This endpoint supports read-after-write and will read the node represented by id in the return type.
Struct {
success: bool,
}
Error Codes
| Error | Description |
|---|---|
| 100 | Invalid parameter |
| 200 | Permissions error |
You can update an Application by making a POST request to /{application_id}/mmp_auditing.
Parameters
| Parameter | Description |
|---|---|
advertiser_id<br>string | Apple's Identifier for Advertisers (IDFA) or Android's Advertising ID. You can see how Facebook fetches this on iOS or on Android |
attribution<br>string | mobile_cookie from the person's device. Use this only on Android or iOS devices before iOS 6. The format for this should be like DDDECD0A-C076-4050-8CE8-C20EC3FC2BD3 |
attribution_method<br>string | The attribution method used. The options are: {ARD, DEEPLINK, GPIR, MIR, SRN} |
attribution_model<br>string | The attribution model that the client selected to be respected by MMP |
attribution_referrer<br>string | The attribution referrer, if one was used |
auditing_token<br>string | The token provided in claim response sent to MMP |
click_attr_window<br>int64 | Time window of click attribution |
custom_events<br>list<CustomEvent> | When the event_type is custom_app_events, custom_events should contain the names of the custom events. |
_eventName<br>RegexParam | Event name, must match the regular expression /^[0-9a-zA-Z_][0-9a-zA-Z _-]{0,39}$/<br>Required |
_eventName_md5<br>RegexParam | MD5 hash of the event name, must match the regular expression /^[A-Fa-f0-9]{32}$/ |
_valueToSum<br>float | Values to Sum |
_logTime<br>int64 | Time to Log |
_implicitlyLogged<br>int64 | Whether this is implicitly logged |
_isTimedEvent<br>boolean | Whether this is a timed event |
_session_id<br>string | |
_app_user_id<br>string | |
decline_reason<br>string | The reason that the MMP rejected Meta's claim |
device_os<br>string | The OS of the device the event was on |
engagement_type<br>string | The engagement type from Meta's claim, such as engaged_view |
event<br>string | Event type that Facebook claimed for<br>Required |
event_id<br>string | An MMP-defined event ID, unique for each event |
event_reported_time<br>int64 | The time at which the event was reported to MMP |
fb_ad_id<br>int64 | FBID of the ad in Meta's claim |
fb_adgroup_id<br>int64 | FBID of the adgroup. Provide this parameter when the attribution method is ARD (auto-redirect). |
fb_click_time<br>int64 | Ad click time in Meta claim |
fb_view_time<br>int64 | Ad view time in Meta claim |
google_install_referrer<br>string | The raw GPIR referrer string, if this event was attributed by GPIR |
inactivity_window_hours<br>int64 | Inactivity window in hours |
install_id<br>string | If this is an install event, install_id should be an MMP-generated ID unique across all installs (which can be the same as the event_id). If this is a post-install event, the install_id should be MMP-defined install_id of the install event that preceded this event. |
is_fb<br>boolean | Result (whether the MMP attributed the event to Meta ads)<br>Required |
meta_install_referrer<br>string | The raw MIR referrer string, if this event was attributed by MIR |
used_install_referrer<br>boolean | Identifies whether MMP used the install referrer |
view_attr_window<br>int64 | Time window of view attribution |
Return Type
Struct {
success: bool,
} Or Struct {
success: bool,
}
Error Codes
| Error | Description |
|---|---|
| 100 | Invalid parameter |
Deleting
You can dissociate an Application from a Page by making a DELETE request to /{page_id}/subscribed_apps.
Parameters
This endpoint doesn't have any parameters.
Return Type
Struct {
success: bool,
messaging_success: bool,
}
Error Codes
| Error | Description |
|---|---|
| 100 | Invalid parameter |
| 190 | Invalid OAuth 2.0 Access Token |
| 210 | User not visible |
| 200 | Permissions error |
| 104 | Incorrect signature |
You can dissociate an Application from an AdAccount by making a DELETE request to /act_{ad_account_id}/subscribed_apps.
Parameters
| Parameter | Description |
|---|---|
app_id<br>string | Default value: ``<br>the id of app to be unsubscribed from ad account |
Return Type
Struct {
success: bool,
}
Error Codes
| Error | Description |
|---|---|
| 100 | Invalid parameter |