> ## 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 referrals



## OpenAPI

````yaml /openapi/orders.json get /v1/crm/requests/referrals/{id}/
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/requests/referrals/{id}/:
    get:
      tags:
        - referrals
      summary: Get referrals
      operationId: referrals_retrieve
      parameters:
        - in: path
          name: id
          schema:
            type: integer
          required: true
        - $ref: '#/components/parameters/TenantId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderRequestReferral'
          description: ''
      security:
        - jwtAuth: []
components:
  parameters:
    TenantId:
      name: X-Tenant-Id
      in: header
      required: false
      schema:
        type: integer
      description: >-
        Компания, в контексте которой выполняется запрос — её id из `GET
        /v1/tenant/`. Пользователь должен состоять в этой компании: чужой id
        доступа к данным не даёт. Без заголовка компания определяется по домену
        запроса.
  schemas:
    OrderRequestReferral:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
          title: Создан
        request:
          type: integer
          readOnly: true
          title: Аренда
        agent:
          type: integer
          nullable: true
          title: Агент
        amount:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
          title: Сумма
        status:
          allOf:
            - $ref: '#/components/schemas/OrderRequestReferralStatusEnum'
          readOnly: true
          title: Статус
        status_changed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
          title: Статус изменён
        request_status:
          type: integer
          readOnly: true
      required:
        - created_at
        - id
        - request
        - request_status
        - status
        - status_changed_at
    OrderRequestReferralStatusEnum:
      enum:
        - 0
        - 1
      type: integer
      description: |-
        * `0` - Выплачено
        * `1` - Ожидает
  securitySchemes:
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````