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



## OpenAPI

````yaml /openapi/sales.json get /v1/sales/leads/
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/sales/leads/:
    get:
      tags:
        - leads
      summary: Get leads
      operationId: leads_list
      parameters:
        - in: query
          name: has_no_tasks
          schema:
            type: boolean
          description: Filter leads that carry no task at all
        - in: query
          name: has_overdue_tasks
          schema:
            type: boolean
          description: Filter leads with an unfinished task whose due date has passed
        - name: ordering
          required: false
          in: query
          description: Which field to use when ordering the results.
          schema:
            type: string
        - name: page
          required: false
          in: query
          description: A page number within the paginated result set.
          schema:
            type: integer
        - name: pageSize
          required: false
          in: query
          description: Number of results to return per page.
          schema:
            type: integer
        - name: search
          required: false
          in: query
          description: A search term.
          schema:
            type: string
        - $ref: '#/components/parameters/TenantId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedLeadListList'
          description: ''
      security:
        - jwtAuth: []
components:
  parameters:
    TenantId:
      name: X-Tenant-Id
      in: header
      required: false
      schema:
        type: integer
      description: >-
        Компания, в контексте которой выполняется запрос — её id из `GET
        /v1/tenant/`. Пользователь должен состоять в этой компании: чужой id
        доступа к данным не даёт. Без заголовка компания определяется по домену
        запроса.
  schemas:
    PaginatedLeadListList:
      type: object
      required:
        - count
        - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/LeadList'
    LeadList:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        task_date:
          type: string
          format: date-time
          readOnly: true
        request_status:
          type: integer
          readOnly: true
          nullable: true
        request_price:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
          readOnly: true
          nullable: true
        client_phone:
          type: string
          readOnly: true
          nullable: true
        client_name:
          type: string
          readOnly: true
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
          title: Создан
        updated_at:
          type: string
          format: date-time
          readOnly: true
          title: Обновлен
        price:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        ordering:
          type: integer
          maximum: 2147483647
          minimum: 0
        cancel_reason:
          type: string
          nullable: true
        extra: {}
        tenant:
          type: integer
        client:
          type: integer
          nullable: true
        stage:
          type: integer
        funnel:
          type: integer
        manager:
          type: integer
          nullable: true
        source:
          type: integer
          nullable: true
        request:
          type: integer
          nullable: true
        sale:
          type: integer
          nullable: true
      required:
        - client_name
        - client_phone
        - created_at
        - funnel
        - id
        - request_price
        - request_status
        - stage
        - task_date
        - updated_at
  securitySchemes:
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````