---
title: "Returns a paged list of brands and provides search functionality."
url: "https://developer-qual.migros.ch/apis/brands-8/versions/ab5a34c1-7bab-42d3-99fa-949cd2fac52f/operations/getBrands"
---

> Full API specification: https://developer-qual.migros.ch/apis/brands-8/versions/ab5a34c1-7bab-42d3-99fa-949cd2fac52f.md

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

`GET` `/migros/products/v8/brands`

Operation ID: `getBrands`

Returns a paged list of brands and provides search functionality.

## Query parameters

- `limit` (integer, optional) - Maximum number of results (max 2000).
- `offset` (integer, optional) - Result set offset.
- `order` (string, optional) - The ordering direction.
- `sort` (string, optional) - The sorting criteria.
- `ids` (string, optional) - A comma separated list or an array of brand ids defining the brands and the order in which the brands should be returned. If the ids parameter is provided all other filtering parameters are ignored.
- `updated_since` (string, optional) - The date and time used to only get brands updated since a certain timestamp. The format is according to ISO 8601 and can include a time zone offset, e.g. 2018-01-01T06:00:00+01:00. Default time zone is Swiss time.
- `lang` (string, optional) - The language to be used. Possible values: `de`, `fr`, `it`, `en`. The language may also be set via HTTP header, e.g. `Accept-Language: de` header.

## Responses

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

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Brands
  version: "8"
servers:
  - description: Public Kong Gateway URL
    url: https://api-qual.migros.ch
paths:
  /migros/products/v8/brands:
    get:
      description: Returns a paged list of brands and provides search functionality.
      operationId: getBrands
      parameters:
        - description: Maximum number of results (max 2000).
          in: query
          name: limit
          required: false
          schema:
            default: 10
            maximum: 2000
            minimum: 0
            type: integer
        - description: Result set offset.
          in: query
          name: offset
          required: false
          schema:
            default: 0
            minimum: 0
            type: integer
        - description: The ordering direction.
          in: query
          name: order
          schema:
            default: asc
            enum:
              - asc
              - desc
            type: string
        - description: The sorting criteria.
          in: query
          name: sort
          schema:
            default: id
            enum:
              - id
              - name
            type: string
        - description: A comma separated list or an array of brand ids defining the brands
            and the order in which the brands should be returned. If the ids
            parameter is provided all other filtering parameters are ignored.
          in: query
          name: ids
          schema:
            type: string
        - description: The date and time used to only get brands updated since a certain
            timestamp. The format is according to ISO 8601 and can include a
            time zone offset, e.g. 2018-01-01T06:00:00+01:00. Default time zone
            is Swiss time.
          in: query
          name: updated_since
          schema:
            type: string
        - description: "The language to be used. Possible values: `de`, `fr`, `it`, `en`.
            The language may also be set via HTTP header, e.g. `Accept-Language:
            de` header."
          in: query
          name: lang
          required: false
          schema:
            default: de
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/BrandCollection"
          description: Returned when successful.
        "400":
          $ref: "#/components/responses/400"
      summary: Returns a paged list of brands and provides search functionality.
      tags:
        - Brands
security:
  - Kong-Api-Key: []
  - basicAuth: []
components:
  schemas:
    BrandCollection:
      description: A collection of brand instances.
      properties:
        brands:
          items:
            $ref: "#/components/schemas/Brand"
          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
      required:
        - brands
        - total_hits
      type: object
    Brand:
      description: Represents the Brand information.
      properties:
        class_id:
          description: Brand class code.
          nullable: true
          type: string
        class_type:
          description: Brand class type.
          nullable: true
          type: string
        description:
          description: The long description of the brand (can contain HTML).
          nullable: true
          type: string
        id:
          type: string
        image:
          nullable: true
          oneOf:
            - $ref: "#/components/schemas/Image"
        links:
          additionalProperties:
            $ref: "#/components/schemas/Link"
          description: Collection of links indexed by string identifier.
          type: object
        name:
          nullable: true
          type: string
        parent_brand:
          nullable: true
          oneOf:
            - $ref: "#/components/schemas/PartialBrand"
        position_for_product_title:
          description: Indicates placement of the short name brand in product title
          nullable: true
          type: string
        short_name_for_product_title:
          description: Shorter variant of the brand for product title
          nullable: true
          type: string
        slug:
          description: Unique user-friendly ID.
          type: string
        sub_brand:
          nullable: true
          oneOf:
            - $ref: "#/components/schemas/PartialBrand"
      required:
        - id
        - name
        - slug
      type: object
    Image:
      description: An image and its properties.
      properties:
        original:
          description: Full size image.
          type: string
        stack:
          description: Image URL with a placeholder for a Rokka {stack}.
          type: string
      type: object
    Link:
      properties:
        url:
          description: URL to a third-party desktop page of the product.
          type: string
      type: object
    PartialBrand:
      description: Represents the sub brand and parent brand information.
      properties:
        code:
          type: string
        name:
          nullable: true
          type: string
      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
```