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

# Get all leads



## OpenAPI

````yaml get /v1/leads
openapi: 3.1.0
info:
  title: Flextell API
  version: 0.0.1
  description: >-
    Flextell REST API referansı. Kimlik doğrulama, scope ve istek kuralları için
    API sekmesindeki rehberlere bakın.
servers:
  - url: https://app.flextell.ai/api
    description: Üretim
security:
  - oauth2: []
  - bearer: []
paths:
  /v1/leads:
    get:
      tags:
        - Lead
      summary: Get all leads
      operationId: lead.index
      parameters:
        - name: pipeline_stage_id
          in: query
          description: Filter by pipeline stage ID.
          schema:
            type:
              - integer
              - 'null'
        - name: lead_reference_source_id
          in: query
          description: Filter by lead reference source ID.
          schema:
            type:
              - integer
              - 'null'
        - name: assigned_user_id[]
          in: query
          description: An assigned user ID to filter by.
          schema:
            type: array
            items:
              type: integer
        - name: converted
          in: query
          description: Filter by converted status (true for converted leads).
          schema:
            type:
              - boolean
              - 'null'
        - name: active
          in: query
          description: >-
            Filter by active status: `true` returns leads that are neither
            converted nor in a won or

            lost stage (the definition the lead cap and the salesperson's
            `active_lead_count` use),

            `false` returns the rest.
          schema:
            type:
              - boolean
              - 'null'
        - name: search
          in: query
          description: The search query.
          schema:
            type:
              - string
              - 'null'
            maxLength: 255
        - name: created_at_from
          in: query
          description: Filter by creation date (inclusive lower bound).
          schema:
            type:
              - string
              - 'null'
            format: date-time
        - name: created_at_to
          in: query
          description: Filter by creation date (inclusive upper bound).
          schema:
            type:
              - string
              - 'null'
            format: date-time
        - name: converted_at_from
          in: query
          description: Filter by conversion date (inclusive lower bound).
          schema:
            type:
              - string
              - 'null'
            format: date-time
        - name: converted_at_to
          in: query
          description: Filter by conversion date (inclusive upper bound).
          schema:
            type:
              - string
              - 'null'
            format: date-time
        - name: sort_by
          in: query
          description: The field to sort by.
          schema:
            type: string
            enum:
              - created_at
              - last_name
              - first_name
              - converted_at
              - last_synced_at
        - name: sort_order
          in: query
          description: The sort direction (asc or desc).
          schema:
            type:
              - string
              - 'null'
            enum:
              - asc
              - desc
              - null
        - name: per_page
          in: query
          description: The number of items per page.
          schema:
            type:
              - integer
              - 'null'
            minimum: 1
            maximum: 100
        - name: page
          in: query
          description: The page number.
          schema:
            type:
              - integer
              - 'null'
            minimum: 1
        - name: X-Tenant
          in: header
          required: true
          description: >-
            Tenant identifier. Send the Tenant ID in the `X-Tenant` header to
            scope API requests to a specific tenant.
          schema:
            type: number
      responses:
        '200':
          description: Paginated set of `LeadResource`
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/LeadResource'
                  links:
                    type: object
                    properties:
                      first:
                        type:
                          - string
                          - 'null'
                      last:
                        type:
                          - string
                          - 'null'
                      prev:
                        type:
                          - string
                          - 'null'
                      next:
                        type:
                          - string
                          - 'null'
                    required:
                      - first
                      - last
                      - prev
                      - next
                  meta:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        minimum: 1
                      from:
                        type:
                          - integer
                          - 'null'
                        minimum: 1
                      last_page:
                        type: integer
                        minimum: 1
                      links:
                        type: array
                        description: Generated paginator links.
                        items:
                          type: object
                          properties:
                            url:
                              type:
                                - string
                                - 'null'
                            label:
                              type: string
                            active:
                              type: boolean
                          required:
                            - url
                            - label
                            - active
                      path:
                        type:
                          - string
                          - 'null'
                        description: Base path for paginator generated URLs.
                      per_page:
                        type: integer
                        description: Number of items shown per page.
                        minimum: 0
                      to:
                        type:
                          - integer
                          - 'null'
                        description: Number of the last item in the slice.
                        minimum: 1
                      total:
                        type: integer
                        description: Total number of items being paginated.
                        minimum: 0
                    required:
                      - current_page
                      - from
                      - last_page
                      - links
                      - path
                      - per_page
                      - to
                      - total
                required:
                  - data
                  - links
                  - meta
        '401':
          $ref: '#/components/responses/AuthenticationException'
        '403':
          $ref: '#/components/responses/AuthorizationException'
        '422':
          $ref: '#/components/responses/ValidationException'
        '428':
          description: >-
            Mandatory setup is incomplete. Finish the setup wizard first;
            `data.next_step` names the step to continue with.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    examples:
                      - false
                  error_code:
                    type: string
                    enum:
                      - SETUP_REQUIRED
                    examples:
                      - SETUP_REQUIRED
                  message:
                    type: string
                    examples:
                      - Complete the required setup steps to continue.
                  data:
                    type: object
                    properties:
                      next_step:
                        type:
                          - string
                          - 'null'
                        examples:
                          - clinic_info
                    required:
                      - next_step
                required:
                  - success
                  - error_code
                  - message
                  - data
components:
  schemas:
    LeadResource:
      type: object
      properties:
        id:
          type: integer
        record_state:
          $ref: '#/components/schemas/RecordStateResource'
        first_name:
          type:
            - string
            - 'null'
        last_name:
          type:
            - string
            - 'null'
        full_name:
          type: string
        phone_number:
          type:
            - string
            - 'null'
        email:
          type:
            - string
            - 'null'
        description:
          type:
            - string
            - 'null'
        message:
          type:
            - string
            - 'null'
        preferred_contact:
          type:
            - string
            - 'null'
        source_page_url:
          type:
            - string
            - 'null'
        avatar_url:
          type:
            - string
            - 'null'
        latest_conversation_id:
          type:
            - integer
            - 'null'
        stage:
          $ref: '#/components/schemas/RelatedPipelineStageResource'
        reference_source:
          $ref: '#/components/schemas/RelatedLeadReferenceSourceResource'
        expected_value:
          type:
            - string
            - 'null'
        treatments:
          type: array
          items:
            type: string
        currency_id:
          type:
            - integer
            - 'null'
        exchange_rate:
          type: string
        assigned_user:
          $ref: '#/components/schemas/RelatedUserResource'
        country_id:
          type:
            - integer
            - 'null'
        country_name:
          type: string
        is_converted:
          type: string
        converted_at:
          type:
            - string
            - 'null'
          format: date-time
        won_at:
          type:
            - string
            - 'null'
          format: date-time
        lost_reason:
          type:
            - string
            - 'null'
        lost_at:
          type:
            - string
            - 'null'
          format: date-time
        lost_by_user_id:
          type:
            - integer
            - 'null'
        customer_id:
          type:
            - integer
            - 'null'
        notification_channels:
          $ref: '#/components/schemas/CustomerNotificationChannelsResource'
        marketing_attribution:
          type:
            - array
            - 'null'
          items: {}
        external_id:
          type:
            - string
            - 'null'
        external_branch_id:
          type:
            - string
            - 'null'
        external_created_at:
          type:
            - string
            - 'null'
          format: date-time
        last_synced_at:
          type:
            - string
            - 'null'
          format: date-time
        import_source_id:
          type:
            - integer
            - 'null'
        import_source:
          anyOf:
            - $ref: '#/components/schemas/RelatedImportSourceResource'
              description: >-
                The external system the record was imported from, or `null` when
                it was created in Flextell. Only present on detail responses.
            - type: 'null'
        integration_source:
          anyOf:
            - $ref: '#/components/schemas/RelatedIntegrationConnectionResource'
              description: >-
                The integration connection (e.g. Zapier) that wrote the lead, or
                `null` when none did. Only present on detail responses.
            - type: 'null'
        created_at:
          type:
            - string
            - 'null'
          format: date-time
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
        deleted_at:
          type:
            - string
            - 'null'
          format: date-time
      required:
        - id
        - record_state
        - first_name
        - last_name
        - full_name
        - phone_number
        - email
        - description
        - message
        - preferred_contact
        - source_page_url
        - avatar_url
        - latest_conversation_id
        - expected_value
        - currency_id
        - exchange_rate
        - country_id
        - is_converted
        - converted_at
        - won_at
        - lost_reason
        - lost_at
        - lost_by_user_id
        - customer_id
        - marketing_attribution
        - external_id
        - external_branch_id
        - external_created_at
        - last_synced_at
        - import_source_id
        - created_at
        - updated_at
        - deleted_at
      title: LeadResource
    RecordStateResource:
      type: object
      properties:
        is_read_only:
          type: boolean
          description: >-
            True when every write on this record is refused; false does not
            imply the caller may write.
        reason_code:
          type:
            - string
            - 'null'
          description: >-
            Why the record is read-only (`CUSTOMER_ERASED`, or
            `LEAD_NOT_ASSIGNED` for a salesperson on another rep's lead), or
            null when it is not.
      required:
        - is_read_only
        - reason_code
      title: RecordStateResource
    RelatedPipelineStageResource:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        color:
          type: string
        is_won:
          type: boolean
        is_lost:
          type: boolean
      required:
        - id
        - name
        - color
        - is_won
        - is_lost
      title: RelatedPipelineStageResource
    RelatedLeadReferenceSourceResource:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        external_id:
          type:
            - string
            - 'null'
      required:
        - id
        - name
        - external_id
      title: RelatedLeadReferenceSourceResource
    RelatedUserResource:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        avatar_url:
          type:
            - string
            - 'null'
          description: >-
            A signed profile photo URL valid for a few hours, or `null` without
            a photo. Only on responses that opt in.
      required:
        - id
        - name
      title: RelatedUserResource
    CustomerNotificationChannelsResource:
      type: object
      properties:
        default_channel_id:
          type:
            - string
            - 'null'
        source:
          type:
            - string
            - 'null'
        channels:
          type: array
          items: {}
      required:
        - default_channel_id
        - source
        - channels
      title: CustomerNotificationChannelsResource
    RelatedImportSourceResource:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        company_logo:
          type: 'null'
      required:
        - id
        - name
        - company_logo
      title: RelatedImportSourceResource
    RelatedIntegrationConnectionResource:
      type: object
      properties:
        connection_id:
          type: integer
          description: The integration connection identifier.
        connection_name:
          type: string
        integration:
          $ref: '#/components/schemas/RelatedIntegrationResource'
        external_id:
          type: string
          description: >-
            The record's own id at the provider (e.g. the Zapier Tables record
            id).
      required:
        - connection_id
        - connection_name
        - integration
        - external_id
      title: RelatedIntegrationConnectionResource
    RelatedIntegrationResource:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        system_name:
          type:
            - string
            - 'null'
        company_logo:
          type: 'null'
          description: >-
            Short-lived (5 minute) signed URL of the integrator logo; `null`
            when none is set.
      required:
        - id
        - name
        - system_name
        - company_logo
      title: RelatedIntegrationResource
  responses:
    AuthenticationException:
      description: Unauthenticated
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
    AuthorizationException:
      description: Authorization error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
    ValidationException:
      description: Validation error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Errors overview.
              errors:
                type: object
                description: A detailed description of each field that failed validation.
                additionalProperties:
                  type: array
                  items:
                    type: string
            required:
              - message
              - errors
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://dev.flextell.ai/oauth/authorize
          tokenUrl: https://dev.flextell.ai/oauth/token
          scopes:
            '*': all
    bearer:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.