Choose a version:

appByKey

query

Fetches an app by its client ID. Returns null if the app doesn't exist.

Arguments

Anchor to apiKeyapiKey • String!required: Client ID of the app.

Was this section helpful?

Anchor to Possible returnsPossible returns

App

•

App

A Shopify application.

apiKey• String! non-null: A unique application API identifier.
appStoreAppUrl• URL: App store page URL of the app.
appStoreDeveloperUrl• URL: App store page URL of the developer who created the app.
availableAccessScopes• [AccessScope!]! non-null: All requestable access scopes available to the app.
banner• Image! non-null: Banner image for the app.
description• String: Description of the app.
developerName• String: The name of the app developer.
developerType• AppDeveloperType! non-null: The type of app developer.
embedded• Boolean! non-null: Whether the app uses the Embedded App SDK.
failedRequirements• [FailedRequirement!]! non-null: Requirements that must be met before the app can be installed.
features• [String!]! non-null: A list of app features that are shown in the Shopify App Store listing.
feedback• AppFeedback: Feedback from this app about the store.
handle• String: Handle of the app.
icon• Image! non-null: Icon that represents the app.
id• ID! non-null: A globally-unique ID.
installation• AppInstallation: Corresponding AppInstallation for this shop and App. Returns null if the App is not installed.
installUrl• URL: Webpage where you can install the app.
isPostPurchaseAppInUse• Boolean! non-null: Whether the app is the post purchase app in use.
optionalAccessScopes• [AccessScope!]! non-null: The optional scopes requested by the app. Lists the optional access scopes the app has declared in its configuration. These scopes are optionally requested by the app after installation.
previouslyInstalled• Boolean! non-null: Whether the app was previously installed on the current shop.
pricingDetails• String: Detailed information about the app pricing.
pricingDetailsSummary• String! non-null: Summary of the app pricing details.
privacyPolicyUrl• URL: Link to app privacy policy.
publicCategory• AppPublicCategory! non-null: The public category for the app.
published• Boolean! non-null: Whether the app is published to the Shopify App Store.
requestedAccessScopes• [AccessScope!]! non-null: The access scopes requested by the app. Lists the access scopes the app has declared in its configuration. Merchant must grant approval to these scopes for the app to be installed.
screenshots• [Image!]! non-null: Screenshots of the app.
shopifyDeveloped• Boolean! non-null: Whether the app was developed by Shopify.
starRating• Float! non-null: The star rating of the app.
title• String! non-null: Name of the app.
uninstallMessage• String! non-null: Message that appears when the app is uninstalled. For example: By removing this app, you will no longer be able to publish products to MySocialSite or view this app in your Shopify admin. You can re-enable this channel at any time.
webhookApiVersion• String! non-null: The webhook API version for the app.
developerUrl• URL! non-nullDeprecated: Website of the developer who created the app. Use appStoreDeveloperUrl instead.
launchUrl• URL! non-nullDeprecated: Webpage that the app starts in. Use AppInstallation.launchUrl instead
navigationItems• [NavigationItem!]! non-nullDeprecated: Menu items for the app, which also appear as submenu items in left navigation sidebar in the Shopify admin. Use AppInstallation.navigationItems instead
uninstallUrl• URL Deprecated: Webpage where you can uninstall the app. Use AppInstallation.uninstallUrl instead

Was this section helpful?