---
title: rollouts - GraphQL Admin
description: Returns the list of rollouts in the shop.
api_version: 2026-10
source_url:
  html: 'https://shopify.dev/docs/api/admin-graphql/latest/queries/rollouts'
  md: 'https://shopify.dev/docs/api/admin-graphql/latest/queries/rollouts.md'
api_name: admin
api_type: graphql
type: query
---

# rollouts

query

Returns the list of rollouts in the shop.

## RolloutConnection arguments

[RolloutConnection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/RolloutConnection)

* after

  [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)

  The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

* before

  [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)

  The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

* first

  [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)

  The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

* last

  [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)

  The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

* query

  [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)

  A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).

  * * default

      string

    * change\_type

      string

    * id

      id

    * name

      string

    - Filter by rollout name.

    - Example:

      * `query=holiday`

      Filter public root rollouts by an exact public change typename. Unknown identifiers match no rollouts.

    - Valid values:

      * `RolloutDiscountActivateChange`
      * `RolloutDiscountExpireChange`
      * `RolloutCatalogActivateChange`
      * `RolloutCatalogDraftChange`
      * `RolloutThemePublishChange`
      * `RolloutCheckoutAndAccountsConfigurationPublishChange`

      Example:

      * `change_type:RolloutDiscountActivateChange`
      * `change_type:RolloutThemePublishChange`

      Filter by `id` range.

    - Example:

      * `id:1234`
      * `id:>=1234`
      * `id:<=1234`

      Filter by rollout name. Matches rollouts whose name contains the search value.

  * status

    string

    Filter by rollout status. Values are case-insensitive; unknown values match no rollouts.

    Valid values:

    * `DRAFT`
    * `SCHEDULED`
    * `PAUSED`
    * `ACTIVE`
    * `CONCLUDED`
    * `ARCHIVED`

    Example:

    * `status:ACTIVE`
    * `status:ACTIVE,DRAFT`

* reverse

  [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)

  Default:false

  Reverse the order of the underlying list.

* sort​Key

  [Rollout​Sort​Keys](https://shopify.dev/docs/api/admin-graphql/latest/enums/RolloutSortKeys)

  Default:ID

  Sort the underlying list by the given key.

***

## Possible returns

* edges

  [\[Rollout​Edge!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/RolloutEdge)

  non-null

  The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.

* nodes

  [\[Rollout!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Rollout)

  non-null

  A list of nodes that are contained in RolloutEdge. 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.

* page​Info

  [Page​Info!](https://shopify.dev/docs/api/admin-graphql/latest/objects/PageInfo)

  non-null

  An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page.

***

## Examples

* ### Discover rollouts by status and change type

  #### Description

  Find active rollouts with discount activation changes.

  #### Query

  ```graphql
  query DiscoverRollouts($first: Int!, $after: String, $query: String!) {
    rollouts(first: $first, after: $after, query: $query, sortKey: UPDATED_AT, reverse: true) {
      nodes {
        id
        name
        status
        trafficAllocation
        effectiveTrafficAllocation
        schedule {
          activateAt
          concludeAt
        }
        treatments {
          id
          split
        }
      }
      pageInfo {
        hasNextPage
        endCursor
      }
    }
  }
  ```

  #### Variables

  ```json
  {
    "first": 1,
    "after": null,
    "query": "status:ACTIVE change_type:RolloutDiscountActivateChange"
  }
  ```

  #### cURL

  ```bash
  curl -X POST \
  https://your-development-store.myshopify.com/admin/api/2026-10/graphql.json \
  -H 'Content-Type: application/json' \
  -H 'X-Shopify-Access-Token: {access_token}' \
  -d '{
  "query": "query DiscoverRollouts($first: Int!, $after: String, $query: String!) { rollouts(first: $first, after: $after, query: $query, sortKey: UPDATED_AT, reverse: true) { nodes { id name status trafficAllocation effectiveTrafficAllocation schedule { activateAt concludeAt } treatments { id split } } pageInfo { hasNextPage endCursor } } }",
   "variables": {
      "first": 1,
      "after": null,
      "query": "status:ACTIVE change_type:RolloutDiscountActivateChange"
    }
  }'
  ```

  #### React Router

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

  export const loader = async ({request}) => {
    const { admin } = await authenticate.admin(request);
    const response = await admin.graphql(
      `#graphql
    query DiscoverRollouts($first: Int!, $after: String, $query: String!) {
      rollouts(first: $first, after: $after, query: $query, sortKey: UPDATED_AT, reverse: true) {
        nodes {
          id
          name
          status
          trafficAllocation
          effectiveTrafficAllocation
          schedule {
            activateAt
            concludeAt
          }
          treatments {
            id
            split
          }
        }
        pageInfo {
          hasNextPage
          endCursor
        }
      }
    }`,
    {
      variables: {
          "first": 1,
          "after": null,
          "query": "status:ACTIVE change_type:RolloutDiscountActivateChange"
      },
    },
    );
    const json = await response.json();
    return json.data;
  }
  ```

  #### Ruby

  ```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 DiscoverRollouts($first: Int!, $after: String, $query: String!) {
      rollouts(first: $first, after: $after, query: $query, sortKey: UPDATED_AT, reverse: true) {
        nodes {
          id
          name
          status
          trafficAllocation
          effectiveTrafficAllocation
          schedule {
            activateAt
            concludeAt
          }
          treatments {
            id
            split
          }
        }
        pageInfo {
          hasNextPage
          endCursor
        }
      }
    }
  QUERY

  variables = {
    "first": 1,
    "after": null,
    "query": "status:ACTIVE change_type:RolloutDiscountActivateChange"
  }

  response = client.query(query: query, variables: variables)
  ```

  #### Node.js

  ```javascript
  const client = new shopify.clients.Graphql({session});
  const data = await client.query({
    data: {
      "query": `query DiscoverRollouts($first: Int!, $after: String, $query: String!) {
        rollouts(first: $first, after: $after, query: $query, sortKey: UPDATED_AT, reverse: true) {
          nodes {
            id
            name
            status
            trafficAllocation
            effectiveTrafficAllocation
            schedule {
              activateAt
              concludeAt
            }
            treatments {
              id
              split
            }
          }
          pageInfo {
            hasNextPage
            endCursor
          }
        }
      }`,
      "variables": {
          "first": 1,
          "after": null,
          "query": "status:ACTIVE change_type:RolloutDiscountActivateChange"
      },
    },
  });
  ```

  #### Shopify CLI

  ```bash
  shopify app execute \
  --query \
  'query DiscoverRollouts($first: Int!, $after: String, $query: String!) {
    rollouts(first: $first, after: $after, query: $query, sortKey: UPDATED_AT, reverse: true) {
      nodes {
        id
        name
        status
        trafficAllocation
        effectiveTrafficAllocation
        schedule {
          activateAt
          concludeAt
        }
        treatments {
          id
          split
        }
      }
      pageInfo {
        hasNextPage
        endCursor
      }
    }
  }' \
  --variables \
  '{
    "first": 1,
    "after": null,
    "query": "status:ACTIVE change_type:RolloutDiscountActivateChange"
  }'
  ```

  #### Direct API Access

  ```javascript
  const response = await fetch('shopify:admin/api/2026-10/graphql.json', {
    method: 'POST',
    body: JSON.stringify({
      query: `
        query DiscoverRollouts($first: Int!, $after: String, $query: String!) {
          rollouts(first: $first, after: $after, query: $query, sortKey: UPDATED_AT, reverse: true) {
            nodes {
              id
              name
              status
              trafficAllocation
              effectiveTrafficAllocation
              schedule {
                activateAt
                concludeAt
              }
              treatments {
                id
                split
              }
            }
            pageInfo {
              hasNextPage
              endCursor
            }
          }
        }
      `,
      variables: {
          "first": 1,
          "after": null,
          "query": "status:ACTIVE change_type:RolloutDiscountActivateChange"
      },
    }),
  });

  const { data } = await response.json();
  console.log(data);
  ```

  #### Response

  ```json
  {
    "rollouts": {
      "nodes": [
        {
          "id": "gid://shopify/Rollout/1795824000000016",
          "name": "Black Friday campaign",
          "status": "ACTIVE",
          "trafficAllocation": 100,
          "effectiveTrafficAllocation": 100,
          "schedule": {
            "activateAt": "2026-11-27T00:00:00Z",
            "concludeAt": "2026-12-01T00:00:00Z"
          },
          "treatments": [
            {
              "id": "gid://shopify/RolloutTreatment/1795824000000024",
              "split": 50
            },
            {
              "id": "gid://shopify/RolloutTreatment/1795824000000026",
              "split": 50
            },
            {
              "id": "gid://shopify/RolloutTreatment/1795824000000027",
              "split": 0
            }
          ]
        }
      ],
      "pageInfo": {
        "hasNextPage": true,
        "endCursor": "eyJsaW1pdCI6MSwic29ydF9maWVsZHMiOiJ1cGRhdGVkX2F0Iiwic29ydF9kaXIiOiJkZXNjIiwibGFzdF9pZCI6MTc5NTgyNDAwMDAwMDAxNiwibGFzdF92YWx1ZSI6WyIyMDI2LTExLTI4IDAwOjAwOjAwLjAwMDAwMCJdLCJkaXJlY3Rpb24iOiJuZXh0In0="
      }
    }
  }
  ```