articleTags

query

Requires read_content access scope or read_online_store_pages access scope.

List of all article tags.

Arguments

Anchor to limitlimit • Int!required: The maximum number of tags to return.
Anchor to sortsort • ArticleTagSortDefault:ALPHABETICAL: Type of sort order.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to StringString • [String!]!: Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

Was this section helpful?

Retrieves a list of all article tags

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

const response = await admin.graphql(

`#graphql

query ArticleTagsList {

articleTags(limit: 10, sort: ALPHABETICAL)

}`,

);

const data = await response.json();

query ArticleTagsList {
  articleTags(limit: 10, sort: ALPHABETICAL)
}

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 ArticleTagsList { articleTags(limit: 10, sort: ALPHABETICAL) }"
}'

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

const response = await admin.graphql(
  `#graphql
  query ArticleTagsList {
    articleTags(limit: 10, sort: ALPHABETICAL)
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query ArticleTagsList {
    articleTags(limit: 10, sort: ALPHABETICAL)
  }`,
});

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 ArticleTagsList {
    articleTags(limit: 10, sort: ALPHABETICAL)
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"articleTags": [

"alpha",

"important",

"not_alpha"

]

}