current App Installation
Returns the for the currently authenticated app. Provides access to granted access scopes, active objects, and billing information for your app.
Use this query to check which permissions your app has, monitor subscription status, or retrieve objects. Learn more about managing access scopes, subscription billing, and app credits.
Anchor to Possible returnsPossible returns
- AppInstallation (AppInstallation!)
- Anchor to AppInstallationApp•App
Installation Installation! An app installed on a shop. Each installation tracks the permissions granted to the app through
objects, along with billing subscriptions andMetafieldobjects.The installation provides metafields that only the owning
Appcan access. These metafields store app-specific configuration that merchants and other apps can't modify. The installation also provides URLs for launching and uninstalling the app, along with any activeobjects orpurchases.- Anchor to accessScopesaccess•[Access
Scopes Scope!]! non-null The access scopes granted to the application by a merchant during installation.
- Anchor to activeSubscriptionsactive•[App
Subscriptions Subscription!]! non-null The active application subscriptions billed to the shop on a recurring basis.
- Anchor to allSubscriptionsall•App
Subscriptions Subscription Connection! non-null All subscriptions created for a shop.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•App
Key Subscription Sort Keys Default:CREATED_AT Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
Arguments
- •App!non-null
Application which is installed.
- Anchor to creditscredits•App
Credit Connection! non-null Credits that can be used towards future app purchases.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•App
Key Transaction Sort Keys Default:CREATED_AT Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
Arguments
- •ID!non-null
A globally-unique ID.
- Anchor to launchUrllaunch•URL!
Url non-null The URL to launch the application.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespaceandkey, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to namespacenamespace•String
The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
- •String!required
The key for the metafield.
Arguments
- Anchor to metafieldsmetafields•Metafield
Connection! non-null A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to namespacenamespace•String
The metafield namespace to filter by. If omitted, all metafields are returned.
- Anchor to keyskeys•[String!]
List of keys of metafields in the format
namespace.key, will be returned in the same format.- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to metafieldsByIdentifiersmetafields•[Metafield]!
By Identifiers non-null The metafields associated with the resource matching the supplied list of namespaces and keys.
- Anchor to identifiersidentifiers•[Has
Metafields Identifier!]! required The list of metafields to retrieve by namespace and key.
Arguments
- Anchor to oneTimePurchasesone•App
Time Purchases Purchase One Time Connection! non-null One-time purchases to a shop.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•App
Key Transaction Sort Keys Default:CREATED_AT Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
Arguments
- Anchor to revenueAttributionRecordsrevenue•App
Attribution Records Revenue Attribution Record Connection! non-null The records that track the externally-captured revenue for the app. The records are used for revenue attribution purposes.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•App
Key Revenue Attribution Record Sort Keys Default:CREATED_AT Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
Arguments
- Anchor to uninstallUrluninstall•URL
Url The URL to uninstall the application.
- Anchor to channelchannel•ChannelDeprecated
- Anchor to publicationpublication•PublicationDeprecated
- Anchor to subscriptionssubscriptions•[App
Subscription!]! non-nullDeprecated