Choose a version:

app

query

Retrieves an App by its ID. If no ID is provided, returns details about the currently authenticated app. The query provides access to app details including title, icon, and pricing information.

If the app isn't installed on the current shop, then the installation field will be null.

Anchor to Arguments

Arguments

Anchor to idid •ID: The ID to lookup the App by.

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?

Examples

Get an app by its ID

Description

Retrieve an app with its ID, returning the app title

Query

query {
  app(id: "gid://shopify/App/193172482") {
    title
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { app(id: \"gid://shopify/App/193172482\") { title } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    app(id: "gid://shopify/App/193172482") {
      title
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 {
    app(id: "gid://shopify/App/193172482") {
      title
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    app(id: "gid://shopify/App/193172482") {
      title
    }
  }`,
});

Response

{
  "app": {
    "title": "Invoicing Application"
  }
}

Get the currently authenticated app

Description

Retrieve the currently authenticated app, returning the app title

Query

query {
  app {
    title
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { app { title } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    app {
      title
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 {
    app {
      title
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    app {
      title
    }
  }`,
});

Response

{
  "app": {
    "title": "Invoicing Application"
  }
}

Get the feedback field

Query

query ShopFeedbackList {
  app(id: "gid://shopify/App/88312") {
    feedback {
      messages {
        message
      }
      feedbackGeneratedAt
      state
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query ShopFeedbackList { app(id: \"gid://shopify/App/88312\") { feedback { messages { message } feedbackGeneratedAt state } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query ShopFeedbackList {
    app(id: "gid://shopify/App/88312") {
      feedback {
        messages {
          message
        }
        feedbackGeneratedAt
        state
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 ShopFeedbackList {
    app(id: "gid://shopify/App/88312") {
      feedback {
        messages {
          message
        }
        feedbackGeneratedAt
        state
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query ShopFeedbackList {
    app(id: "gid://shopify/App/88312") {
      feedback {
        messages {
          message
        }
        feedbackGeneratedAt
        state
      }
    }
  }`,
});

Response

{
  "app": {
    "feedback": {
      "messages": [
        {
          "message": "Buy Button is not connected. Connect your account to use this sales channel."
        }
      ],
      "feedbackGeneratedAt": "2024-12-17T19:29:36Z",
      "state": "REQUIRES_ACTION"
    }
  }
}

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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

const response = await admin.graphql(

`#graphql

query {

app(id: "gid://shopify/App/193172482") {

title

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

query {
  app(id: "gid://shopify/App/193172482") {
    title
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { app(id: \"gid://shopify/App/193172482\") { title } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    app(id: "gid://shopify/App/193172482") {
      title
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    app(id: "gid://shopify/App/193172482") {
      title
    }
  }`,
});

Ruby

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 {
    app(id: "gid://shopify/App/193172482") {
      title
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"app": {

"title": "Invoicing Application"

}