Choose a version:

currentAppInstallation

query

Return the AppInstallation for the currently authenticated App.

Anchor to Possible returnsPossible returns

AppInstallation

•

AppInstallation!

Represents an installed application on a shop.

accessScopes• [AccessScope!]! non-null: The access scopes granted to the application by a merchant during installation.
activeSubscriptions• [AppSubscription!]! non-null: The active application subscriptions billed to the shop on a recurring basis.
allSubscriptions • AppSubscriptionConnection! non-null: All subscriptions created for a shop.
app• App! non-null: Application which is installed.
credits • AppCreditConnection! non-null: Credits that can be used towards future app purchases.
id• ID! non-null: A globally-unique ID.
launchUrl• URL! non-null: The URL to launch the application.
metafield• Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
metafields • MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
metafieldsByIdentifiers• [Metafield]! non-null: The metafields associated with the resource matching the supplied list of namespaces and keys.
oneTimePurchases • AppPurchaseOneTimeConnection! non-null: One-time purchases to a shop.
publication• Publication: The publication associated with the installed application.
revenueAttributionRecords • AppRevenueAttributionRecordConnection! non-null: The records that track the externally-captured revenue for the app. The records are used for revenue attribution purposes.
uninstallUrl• URL: The URL to uninstall the application.
channel• Channel: Channel associated with the installed application.
subscriptions• [AppSubscription!]! non-null: Subscriptions charge to a shop on a recurring basis.

Was this section helpful?

Get a list of access scopes
Retrieves a list of application charges
Retrieves a list of recurring application charges

Examples

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query AccessScopeList {

currentAppInstallation {

accessScopes {

handle

}

}`,

);

const data = await response.json();

query AccessScopeList {
  currentAppInstallation {
    accessScopes {
      handle
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query AccessScopeList { currentAppInstallation { accessScopes { handle } } }"
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query AccessScopeList {
    currentAppInstallation {
      accessScopes {
        handle
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query AccessScopeList {
    currentAppInstallation {
      accessScopes {
        handle
      }
    }
  }`,
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query AccessScopeList {
    currentAppInstallation {
      accessScopes {
        handle
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"currentAppInstallation": {

"accessScopes": [

{

"handle": "read_all_orders"

{

"handle": "read_all_subscription_contracts"

{

"handle": "read_analytics_overviews"

{

"handle": "read_billing"

{

"handle": "read_checkouts"

{

"handle": "read_discovery"

{

"handle": "read_discovery_synonym_groups"

{

"handle": "read_payment_settings"

{

"handle": "read_subscription_plans"

{

"handle": "read_users"