Choose a version:

appByKey

query

Retrieves an App by its client ID (API key). Returns the app's configuration, installation status, AccessScope objects, and developer information.

Returns null if no app exists with the specified client ID.

Anchor to Arguments

Arguments

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

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to AppApp •App: A Shopify application that extends store functionality. Apps integrate with Shopify through APIs to add features, automate workflows, or connect external services.

Provides metadata about the app including its developer information and listing details in the Shopify App Store. Use the installation field to determine if the app is currently installed on the shop and access installation-specific details like granted AccessScope objects. Check failedRequirements before installation to identify any prerequisites that must be met.

Was this section helpful?