---
title: "Returns a paged list of labels."
url: "https://developer-qual.migros.ch/apis/labels-8/versions/0e6de93c-9b6f-4b5c-b003-c0de2deadada/operations/getLabels"
---

> Full API specification: https://developer-qual.migros.ch/apis/labels-8/versions/0e6de93c-9b6f-4b5c-b003-c0de2deadada.md

# Returns a paged list of labels.

`GET` `/migros/products/v8/labels`

Operation ID: `getLabels`

Returns a paged list of labels.

## Query parameters

- `limit` (integer, optional) - Maximum number of results (max 2000).
- `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.
- `ids` (string, optional) - A comma separated list or an array of label ids defining the labels and the order in which the labels 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 labels 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.

## Responses

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

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Labels
  version: "8"
servers:
  - description: Public Kong Gateway URL
    url: https://api-qual.migros.ch
paths:
  /migros/products/v8/labels:
    get:
      description: Returns a paged list of labels.
      operationId: getLabels
      parameters:
        - description: Maximum number of results (max 2000).
          in: query
          name: limit
          required: false
          schema:
            default: 100
            maximum: 2000
            minimum: 0
            type: integer
        - 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
        - description: A comma separated list or an array of label ids defining the labels
            and the order in which the labels 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 labels 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
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/LabelCollection"
          description: Returned when successful
        "400":
          $ref: "#/components/responses/400"
      summary: Returns a paged list of labels.
      tags:
        - Labels
security:
  - Kong-Api-Key: []
  - basicAuth: []
components:
  schemas:
    LabelCollection:
      description: A collection of label instances.
      properties:
        labels:
          items:
            $ref: "#/components/schemas/Label"
          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:
        - labels
        - total_hits
      type: object
    Label:
      description: Represents the Label information in the Product.
      properties:
        description:
          description: The long description of the label (can contain HTML).
          nullable: true
          type: string
        id:
          description: ID of the label.
          type: string
        image:
          description: Image of the label.
          nullable: true
          oneOf:
            - $ref: "#/components/schemas/Image"
        links:
          additionalProperties:
            $ref: "#/components/schemas/Link"
          description: Collection of links indexed by string identifier.
          type: object
        name:
          description: Name of the label.
          type: string
        position_for_product_title:
          description: Indicates placement of the short name label in product title
          nullable: true
          type: string
        short_name_for_product_title:
          description: Shorter label variant of the product title
          nullable: true
          type: string
        slug:
          description: Unique user-friendly ID.
          type: string
      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
  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
```