# urlRedirects - admin-graphql - QUERY Version: 2024-10 ## Description A list of redirects for a shop. ### Access Scopes ## Arguments * [after](/docs/api/admin-graphql/2024-10/scalars/String): String - The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * [before](/docs/api/admin-graphql/2024-10/scalars/String): String - The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * [first](/docs/api/admin-graphql/2024-10/scalars/Int): Int - The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * [last](/docs/api/admin-graphql/2024-10/scalars/Int): Int - The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * [query](/docs/api/admin-graphql/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` | | created_at | time | | id | id | Filter by `id` range. | | | - `id:1234`
- `id:>=1234`
- `id:<=1234` | | path | string | | target | 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-graphql/2024-10/scalars/Boolean): Boolean - Reverse the order of the underlying list. * [savedSearchId](/docs/api/admin-graphql/2024-10/scalars/ID): ID - The ID of a [saved search](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch#field-id). The search’s query string is used as the query argument. * [sortKey](/docs/api/admin-graphql/2024-10/enums/UrlRedirectSortKeys): UrlRedirectSortKeys - 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-graphql/2024-10/objects/UrlRedirectEdge): UrlRedirectEdge! 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-graphql/2024-10/objects/UrlRedirect): UrlRedirect! A list of nodes that are contained in UrlRedirectEdge. 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-graphql/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 URL redirects 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 UrlRedirects { urlRedirects(first: 100) { edges { node { id path target } } } }\"\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: `query UrlRedirects {\n urlRedirects(first: 100) {\n edges {\n node {\n id\n path\n target\n }\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 UrlRedirects {\n urlRedirects(first: 100) {\n edges {\n node {\n id\n path\n target\n }\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 UrlRedirects {\n urlRedirects(first: 100) {\n edges {\n node {\n id\n path\n target\n }\n }\n }\n }`,\n);\n\nconst data = await response.json();\n" Graphql query: "query UrlRedirects {\n urlRedirects(first: 100) {\n edges {\n node {\n id\n path\n target\n }\n }\n }\n}" #### Graphql Input null #### Graphql Response { "data": { "urlRedirects": { "edges": [ { "node": { "id": "gid://shopify/UrlRedirect/510765931", "path": "/page%20with%20many%20spaces", "target": "/products/element" } }, { "node": { "id": "gid://shopify/UrlRedirect/891487173", "path": "/about-us", "target": "/pages/aboutus" } }, { "node": { "id": "gid://shopify/UrlRedirect/905192165", "path": "/about", "target": "/pages/aboutus" } }, { "node": { "id": "gid://shopify/UrlRedirect/979034143", "path": "/2008/01/01/look-at-my-cool-new-snowboard", "target": "/products/draft" } }, { "node": { "id": "gid://shopify/UrlRedirect/984542198", "path": "/aboutus", "target": "/pages/aboutus" } } ] } } }