> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shoply.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# List storefronts

> The store's storefronts: each a design of its site, on a theme. One of them is live (`meta.liveId`), which is the one buyers see. A store holds up to 10. `meta.themes` is the themes a new one can start from.

Needs the `storefronts.read` permission (Read Storefronts).



## OpenAPI

````yaml /api-reference/openapi.json get /stores/{storeId}/storefronts
openapi: 3.1.0
info:
  title: Shoply API
  version: '1'
  description: >-
    Everything a store's own server can do with a secret API key: its catalogue,
    orders, customers, marketing, finance and the rest of what the dashboard
    does. And the Customer API, which a buyer's own device asks with a token of
    theirs.
servers:
  - url: https://api.shoply.gg/v1
security:
  - apiKey: []
tags:
  - name: API key
  - name: Store
  - name: Domain
  - name: Payment methods
  - name: Analytics
  - name: Storefronts
  - name: Storefront code
  - name: Payment Routing
  - name: Custom payment methods
  - name: Products
  - name: Product pictures
  - name: Stock
  - name: Categories
  - name: Upsells
  - name: Subscriptions
  - name: Orders
  - name: Invoices
  - name: Reviews
  - name: Coupons
  - name: Coupon categories
  - name: Coupon pop-up
  - name: Sales
  - name: Blog
  - name: Search settings
  - name: Redirects
  - name: Sitemap
  - name: Cart Recovery
  - name: Email Marketing
  - name: Email Templates
  - name: Customers
  - name: Affiliates
  - name: Support Tickets
  - name: Blacklist
  - name: Fraud protection
  - name: Disputes
  - name: Finance
  - name: Tax
  - name: Expenses
  - name: Expense setup
  - name: API requests
  - name: Webhook endpoints
  - name: Webhook deliveries
  - name: Customer API
paths:
  /stores/{storeId}/storefronts:
    get:
      tags:
        - Storefronts
      summary: List storefronts
      description: >-
        The store's storefronts: each a design of its site, on a theme. One of
        them is live (`meta.liveId`), which is the one buyers see. A store holds
        up to 10. `meta.themes` is the themes a new one can start from.


        Needs the `storefronts.read` permission (Read Storefronts).
      operationId: storefronts.list
      parameters:
        - name: storeId
          in: path
          required: true
          description: >-
            The store's ID. A key reaches the store it was made in: `GET /key`
            answers which.
          schema:
            type: string
      responses:
        '200':
          description: It worked.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    nullable: true
                  code:
                    nullable: true
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        theme:
                          type: string
                        themeVersion:
                          type: string
                        published:
                          type: boolean
                        publishedAt:
                          nullable: true
                        live:
                          type: boolean
                        createdAt:
                          type: string
                        updatedAt:
                          type: string
                        code:
                          type: boolean
                        engine:
                          type: string
                        codeOnCopy:
                          nullable: true
                        unpublished:
                          type: boolean
                        accent:
                          nullable: true
                        headingFont:
                          nullable: true
                        pages:
                          type: integer
                  meta:
                    type: object
                    properties:
                      liveId:
                        nullable: true
                      limit:
                        type: integer
                      themes:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                            description:
                              type: string
                            version:
                              type: string
                            schemes:
                              type: array
                              items:
                                type: string
                            headingFont:
                              type: string
                            features:
                              type: array
                              items:
                                type: string
                            demoUrl:
                              type: string
                      storeUrl:
                        type: string
                      storeAccent:
                        type: string
              example:
                success: true
                message: null
                code: null
                data:
                  - id: 93618f34-cfad-44d8-a677-253b7238f272
                    name: Autumn look
                    theme: keystone
                    themeVersion: 2.6.0
                    published: false
                    publishedAt: null
                    live: false
                    createdAt: '2026-10-22T16:20:20Z'
                    updatedAt: '2026-10-22T16:20:20Z'
                    code: true
                    engine: files
                    codeOnCopy: null
                    unpublished: false
                    accent: null
                    headingFont: null
                    pages: 6
                meta:
                  liveId: null
                  limit: 10
                  themes:
                    - id: simplistic
                      name: Simplistic
                      description: >-
                        Product cards, a search bar at the top, categories as
                        tiles and a slide-out cart.
                      version: 2.5.0
                      schemes:
                        - light
                        - dark
                      headingFont: Inter
                      features:
                        - Light and dark mode
                        - Your logo, favicon and accent colour
                      demoUrl: https://simplistic-demo.myshoply.gg
                    - id: keystone
                      name: Keystone
                      description: >-
                        A full-screen hero with search, category covers and a
                        product page built around one buy panel.
                      version: 2.6.0
                      schemes:
                        - dark
                      headingFont: Red Hat Display
                      features:
                        - Dark look in your accent colour, pictures included
                        - Full-screen hero with search and shortcuts
                      demoUrl: https://keystone-demo.myshoply.gg
                  storeUrl: https://northwind.myshoply.gg
                  storeAccent: '#6a3ce2'
        '401':
          $ref: '#/components/responses/NoKey'
        '403':
          $ref: '#/components/responses/NotAllowed'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooMany'
      x-codeSamples:
        - lang: javascript
          label: Node.js
          source: |
            import Shoply from "@shoplygg/node";

            const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

            const result = await shoply.storefronts.list();
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

            $shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);

            $result = $shoply->storefronts->list();
        - lang: python
          label: Python
          source: |
            import shoply

            client = shoply.Client()  # reads SHOPLY_API_KEY

            result = client.storefronts.list()
components:
  responses:
    NoKey:
      description: >-
        No API key was sent, or the one sent is not a live key:
        `api_key_required`, `invalid_api_key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotAllowed:
      description: >-
        The key is real and may not do this: `missing_scope` (with
        `requiredScope`), `ip_not_allowed`, `account_unavailable`, or
        `dashboard_only` for something only a person in the dashboard may do.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotFound:
      description: >-
        There is no such thing in this store: `not_found`. A store that is not
        the key's own is answered the same way.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    TooMany:
      description: >-
        The key has used up its budget for now: `rate_limited`. `Retry-After`
        says how many seconds to wait.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
  schemas:
    Refusal:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          description: What is wrong, in words for a person.
        code:
          type: string
          description: What is wrong, as a word that does not change.
        data:
          nullable: true
        errors:
          type: object
          description: >-
            For `validation_failed`: what is wrong with each field, by the
            field's name.
          additionalProperties:
            type: string
      required:
        - success
        - message
        - code
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        A secret API key, made under Developers in the dashboard:
        `Authorization: Bearer shoply_sk_...`

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.