---
title: "Returns a paged list of search teasers and provides search functionality."
url: "https://developer-qual.migros.ch/apis/search-teasers-8/versions/25833665-10ac-48a9-8f88-e79e0eb439dc/operations/get-search-teasers"
---

> Full API specification: https://developer-qual.migros.ch/apis/search-teasers-8/versions/25833665-10ac-48a9-8f88-e79e0eb439dc.md

# Returns a paged list of search teasers and provides search functionality.

`GET` `/migros/products/v8/teasers`

Operation ID: `get-search-teasers`

Returns a paged list of search teasers and provides search functionality.

## Query parameters

- `search` (string, optional) - Simple search string which is fault-tolerant for user-entered text.
- `view` (string, optional) - Show specific set of search teasers. Either 'all' or 'browse' (hiding unwanted search teasers).
- `limit` (integer, optional) - Maximum number of results (max 2000).
- `offset` (integer, optional) - Result set offset.
- `custom_image` (boolean, optional) - Whether to output the custom image format with placeholders for width and height.
- `lang` (string, optional) - Defines the language (de/fr/it/en) for this request as query parameter. Either use the query param "lang" or header "Accept-Language", not both.

## Header parameters

- `Accept-Language` (string, optional) - Defines the language (de/fr/it/en) for this request as request header. Either use the query param "lang" or header "Accept-Language", not both.

## Responses

- `200` - Returned when successful
- `400` - If the request parameters are invalid.

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Search Teasers
  version: "8"
servers:
  - description: Public Kong Gateway URL
    url: https://api-qual.migros.ch
paths:
  /migros/products/v8/teasers:
    get:
      description: Returns a paged list of search teasers and provides search functionality.
      operationId: get-search-teasers
      parameters:
        - $ref: "#/components/parameters/search"
        - description: Show specific set of search teasers. Either 'all' or 'browse'
            (hiding unwanted search teasers).
          in: query
          name: view
          schema:
            default: browse
            enum:
              - all
              - browse
            type: string
        - $ref: "#/components/parameters/limit"
        - $ref: "#/components/parameters/offset"
        - $ref: "#/components/parameters/custom_image"
        - $ref: "#/components/parameters/lang"
        - $ref: "#/components/parameters/Accept-Language"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchTeaserCollection"
          description: Returned when successful
        "400":
          $ref: "#/components/responses/400"
      summary: Returns a paged list of search teasers and provides search functionality.
      tags:
        - Search Teasers
security:
  - Kong-Api-Key: []
    basicAuth: []
components:
  parameters:
    search:
      description: Simple search string which is fault-tolerant for user-entered text.
      in: query
      name: search
      required: false
      schema:
        type: string
    limit:
      description: Maximum number of results (max 2000).
      in: query
      name: limit
      required: false
      schema:
        default: 10
        maximum: 2000
        minimum: 0
        type: integer
    offset:
      description: Result set offset.
      in: query
      name: offset
      required: false
      schema:
        default: 0
        minimum: 0
        type: integer
    custom_image:
      description: Whether to output the custom image format with placeholders for
        width and height.
      in: query
      name: custom_image
      schema:
        default: false
        type: boolean
    lang:
      description: Defines the language (de/fr/it/en) for this request as query
        parameter. Either use the query param "lang" or header
        "Accept-Language", not both.
      in: query
      name: lang
      schema:
        default: de
        enum:
          - de
          - fr
          - it
          - en
        type: string
    Accept-Language:
      description: Defines the language (de/fr/it/en) for this request as request
        header. Either use the query param "lang" or header "Accept-Language",
        not both.
      in: header
      name: Accept-Language
      schema:
        default: de
        enum:
          - de
          - fr
          - it
          - en
        type: string
  schemas:
    SearchTeaserCollection:
      allOf:
        - $ref: "#/components/schemas/AbstractSearchResultCollection"
        - properties:
            teasers:
              items:
                $ref: "#/components/schemas/SearchTeaser"
              type: array
          type: object
      description: A collection of search teaser instances.
      required:
        - teasers
        - total_hits
      type: object
    AbstractSearchResultCollection:
      allOf:
        - $ref: "#/components/schemas/AbstractCollection"
        - properties:
            ids:
              description: >-
                Ids only.


                Is filled instead of the usual property for content, with only
                the ids when a call is made with verbosity=id on a

                route that supports it.
              items:
                type: string
              type: array
            total_hits:
              description: >-
                The total hits may exceed the actual count of results in the
                collection.


                It represents the total number of results of a search and not
                only the

                potentially paginated subset.
              nullable: true
              type: integer
          type: object
      description: A collection of search result instances.
      type: object
    SearchTeaser:
      description: Represents a search teaser entry from the migros website.
      properties:
        active:
          type: boolean
        description:
          nullable: true
          type: string
        end:
          format: date-time
          nullable: true
          type: string
        id:
          description: The uuid.
          type: string
        image:
          nullable: true
          oneOf:
            - $ref: "#/components/schemas/Image"
        keywords:
          nullable: true
          type: string
        language:
          type: string
        link:
          nullable: true
          type: string
        modification_date:
          format: date-time
          nullable: true
          type: string
        name:
          type: string
        parent_id:
          nullable: true
          type: string
        start:
          format: date-time
          nullable: true
          type: string
        title:
          nullable: true
          type: string
      required:
        - id
        - language
        - name
      type: object
    AbstractCollection:
      description: A generic collection of elements.
    Image:
      description: An image and its properties.
      properties:
        code:
          deprecated: true
          description: Code for the image, useful for pictograms.
          nullable: true
          type: string
        custom:
          deprecated: true
          description: Image URL with placeholders for {width} and {height}.
          type: string
        description:
          deprecated: true
          description: Image description, useful for example as alt attribute.
          nullable: true
          type: string
        end_date:
          deprecated: true
          description: End date of the validity.
          format: date-time
          nullable: true
          type: string
        hash:
          deprecated: true
          description: Sha1 hash of original image.
          nullable: true
          type: string
        original:
          deprecated: true
          description: Full size image.
          type: string
        source:
          deprecated: true
          description: Source where the image comes from originally.
          nullable: true
          type: string
        stack:
          deprecated: true
          description: Image URL with a placeholder for a Rokka {stack}.
          type: string
        start_date:
          deprecated: true
          description: Start date of the validity.
          format: date-time
          nullable: true
          type: string
        tags:
          deprecated: true
          items:
            type: string
          type: array
      type: object
  responses:
    "400":
      description: If the request parameters are invalid.
  securitySchemes:
    Kong-Api-Key:
      description: Kong key-auth authentication
      in: header
      name: X-Api-Key
      type: apiKey
    basicAuth:
      scheme: basic
      type: http
```