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

# The install screen's welcome carousel

> Returns the slides the install screen shows while a new store's catalog imports, as the back office saved them. The same for every merchant; call it to see the current carousel. Read-only.



## OpenAPI

````yaml /api-reference/openapi/lite.json get /welcome-slides
openapi: 3.1.0
info:
  title: Search & Merchandising API
  version: 1.0.0
  description: >-
    REST API behind Depict: Search & Merchandising, the native Shopify app:
    onboarding, collections, boost & bury, dashboards, A/B testing and
    multi-store management. Endpoints are served under the /api/lite prefix and
    are authenticated with the Shopify session token that App Bridge issues to
    the embedded app.
servers:
  - url: /api/lite
security:
  - ShopifySessionToken: []
paths:
  /welcome-slides:
    get:
      summary: The install screen's welcome carousel
      description: >-
        Returns the slides the install screen shows while a new store's catalog
        imports, as the back office saved them. The same for every merchant;
        call it to see the current carousel. Read-only.
      operationId: welcomeSlides
      responses:
        '200':
          description: The saved slides.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WelcomeSlidesResponse'
        '401':
          description: Not authenticated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '403':
          description: Authenticated, but this identity may not call the API.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '500':
          description: Internal error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
components:
  schemas:
    WelcomeSlidesResponse:
      type: object
      properties:
        version:
          type: integer
          description: >-
            0 when the back office never saved: the app keeps its built-in
            carousel.
        slides:
          type: array
          items:
            $ref: '#/components/schemas/WelcomeSlide'
          description: >-
            Carousel order; only slides switched on in the back office (at most
            12).
      required:
        - version
        - slides
    Detail:
      type: object
      properties:
        detail:
          type: string
      required:
        - detail
      description: 'Every 4xx/5xx body: `{detail}`.'
    WelcomeSlide:
      type: object
      properties:
        id:
          type: string
        title:
          type: string
        asset:
          type:
            - string
            - 'null'
          description: >-
            Key of a picture bundled with the app; null when the slide uses
            `image_url`.
        image_url:
          type:
            - string
            - 'null'
          description: https URL of the slide picture; null when it uses a bundled `asset`.
      required:
        - id
        - title
        - asset
        - image_url
  securitySchemes:
    ShopifySessionToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Shopify App Bridge session token of the embedded Depict: Search &
        Merchandising app. The shop in the token determines the merchant;
        merchant_id parameters must belong to that shop.

````