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

# Get promo



## OpenAPI

````yaml /openapi/settings.json get /v1/crm/settings/promo/
openapi: 3.0.3
info:
  title: Yume API — Настройки
  version: 1.0.0
  description: Настройки приложения и пользовательские предпочтения.
servers:
  - url: https://api.yume.cloud
    description: Production
  - url: https://api.stage.yume.cloud
    description: Stage
security: []
paths:
  /v1/crm/settings/promo/:
    get:
      tags:
        - promo
      summary: Get promo
      operationId: promo_retrieve
      parameters:
        - $ref: '#/components/parameters/TenantId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Promo'
          description: ''
      security:
        - jwtAuth: []
components:
  parameters:
    TenantId:
      name: X-Tenant-Id
      in: header
      required: false
      schema:
        type: integer
      description: >-
        Компания, в контексте которой выполняется запрос — её id из `GET
        /v1/tenant/`. Пользователь должен состоять в этой компании: чужой id
        доступа к данным не даёт. Без заголовка компания определяется по домену
        запроса.
  schemas:
    Promo:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        title:
          type: string
          maxLength: 255
        description:
          type: string
        code:
          type: string
          nullable: true
          maxLength: 255
        icon:
          type: string
          nullable: true
          maxLength: 255
        link:
          type: string
          nullable: true
          maxLength: 255
        image:
          type: string
          format: uri
          nullable: true
        gif:
          type: string
          format: uri
          nullable: true
      required:
        - description
        - id
        - title
  securitySchemes:
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````