# comments - admin - QUERY Version: 2024-10 ## Description List of the shop's comments. ### Access Scopes ## Arguments * [after](/docs/api/admin/2024-10/scalars/String): String - The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * [before](/docs/api/admin/2024-10/scalars/String): String - The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * [first](/docs/api/admin/2024-10/scalars/Int): Int - The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * [last](/docs/api/admin/2024-10/scalars/Int): Int - The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * [query](/docs/api/admin/2024-10/scalars/String): String - A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | default | string | Filter by a case-insensitive search of multiple fields in a document. | | | - `query=Bob Norman`
- `query=title:green hoodie` | | id | id | Filter by `id` range. | | | - `id:1234`
- `id:>=1234`
- `id:<=1234` | | published_status | string | Filter by published status | - `any`
- `published`
- `unpublished` | | - `published_status:any`
- `published_status:published`
- `published_status:unpublished` | | status | string | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax). * [reverse](/docs/api/admin/2024-10/scalars/Boolean): Boolean - Reverse the order of the underlying list. * [sortKey](/docs/api/admin/2024-10/enums/CommentSortKeys): CommentSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used in the search](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations). ## Returns * [edges](/docs/api/admin/2024-10/objects/CommentEdge): CommentEdge! The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. * [nodes](/docs/api/admin/2024-10/objects/Comment): Comment! A list of nodes that are contained in CommentEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. * [pageInfo](/docs/api/admin/2024-10/objects/PageInfo): PageInfo! An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. ## Examples ### Retrieves a list of comments Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query CommentList { comments(first: 50) { nodes { id body bodyHtml author { name } ip publishedAt status userAgent } } }\"\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: `query CommentList {\n comments(first: 50) {\n nodes {\n id\n body\n bodyHtml\n author {\n name\n }\n ip\n publishedAt\n status\n userAgent\n }\n }\n }`,\n});\n" Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n query CommentList {\n comments(first: 50) {\n nodes {\n id\n body\n bodyHtml\n author {\n name\n }\n ip\n publishedAt\n status\n userAgent\n }\n }\n }\nQUERY\n\nresponse = client.query(query: query)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query CommentList {\n comments(first: 50) {\n nodes {\n id\n body\n bodyHtml\n author {\n name\n }\n ip\n publishedAt\n status\n userAgent\n }\n }\n }`,\n);\n\nconst data = await response.json();\n" Graphql query: "query CommentList {\n comments(first: 50) {\n nodes {\n id\n body\n bodyHtml\n author {\n name\n }\n ip\n publishedAt\n status\n userAgent\n }\n }\n}" #### Graphql Input null #### Graphql Response { "data": { "comments": { "nodes": [ { "id": "gid://shopify/Comment/9450891", "body": "Check my casino at ... This will be marked as spam by akismet, because of the author name.", "bodyHtml": "

Check my casino at ... This will be marked as spam by akismet, because of the author name.

", "author": { "name": "viagra-test-123" }, "ip": "127.0.0.1", "publishedAt": null, "status": "SPAM", "userAgent": "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_4; en-us) AppleWebKit/525.18 (KHTML, like Gecko) Version/3.1.2 Safari/525.20.1" }, { "id": "gid://shopify/Comment/52127930", "body": "Hi author, I really _like_ what you're doing there.", "bodyHtml": "

Hi author, I really like what you're doing there.

", "author": { "name": "Soleone" }, "ip": "127.0.0.1", "publishedAt": null, "status": "PENDING", "userAgent": "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_4; en-us) AppleWebKit/525.18 (KHTML, like Gecko) Version/3.1.2 Safari/525.20.1" }, { "id": "gid://shopify/Comment/64683838", "body": "Check my casino at ... This will be marked as spam by akismet, because of the author name.", "bodyHtml": "

Check my casino at ... This will be marked as spam by akismet, because of the author name.

", "author": { "name": "viagra-test-123" }, "ip": "127.0.0.1", "publishedAt": null, "status": "PENDING", "userAgent": "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_4; en-us) AppleWebKit/525.18 (KHTML, like Gecko) Version/3.1.2 Safari/525.20.1" }, { "id": "gid://shopify/Comment/145356500", "body": "Great blog, love it!", "bodyHtml": "

Great blog, love it!

", "author": { "name": "Bob Bobsen" }, "ip": "127.0.0.1", "publishedAt": null, "status": "PUBLISHED", "userAgent": "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_4; en-us) AppleWebKit/525.18 (KHTML, like Gecko) Version/3.1.2 Safari/525.20.1" }, { "id": "gid://shopify/Comment/757536350", "body": "Check my casino at ... This will be marked as spam by akismet, because of the author name.", "bodyHtml": "

Check my casino at ... This will be marked as spam by akismet, because of the author name.

", "author": { "name": "viagra-test-123" }, "ip": "127.0.0.1", "publishedAt": null, "status": "UNAPPROVED", "userAgent": "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_4; en-us) AppleWebKit/525.18 (KHTML, like Gecko) Version/3.1.2 Safari/525.20.1" } ] } } }